software.amazon.awssdk.services.transfer.model

Interface UpdateConnectorRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateConnectorRequest.Builder,UpdateConnectorRequest>, SdkBuilder<UpdateConnectorRequest.Builder,UpdateConnectorRequest>, SdkPojo, SdkRequest.Builder, TransferRequest.Builder

Enclosing class:

UpdateConnectorRequest

public static interface UpdateConnectorRequest.Builder
extends TransferRequest.Builder, SdkPojo, CopyableBuilder<UpdateConnectorRequest.Builder,UpdateConnectorRequest>

Method Summary

Modifier and Type	Method and Description
UpdateConnectorRequest.Builder	accessRole(String accessRole) With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths.
UpdateConnectorRequest.Builder	as2Config(As2ConnectorConfig as2Config) A structure that contains the parameters for a connector object.
default UpdateConnectorRequest.Builder	as2Config(Consumer<As2ConnectorConfig.Builder> as2Config) A structure that contains the parameters for a connector object.
UpdateConnectorRequest.Builder	connectorId(String connectorId) The unique identifier for the connector.
UpdateConnectorRequest.Builder	loggingRole(String loggingRole) The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events.
UpdateConnectorRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateConnectorRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateConnectorRequest.Builder	url(String url) The URL of the partner's AS2 endpoint.

Methods inherited from interface software.amazon.awssdk.services.transfer.model.TransferRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

connectorId

UpdateConnectorRequest.Builder connectorId(String connectorId)

The unique identifier for the connector.

Parameters:

connectorId - The unique identifier for the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

url

UpdateConnectorRequest.Builder url(String url)

The URL of the partner's AS2 endpoint.

Parameters:

url - The URL of the partner's AS2 endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

as2Config

UpdateConnectorRequest.Builder as2Config(As2ConnectorConfig as2Config)

A structure that contains the parameters for a connector object.

Parameters:

as2Config - A structure that contains the parameters for a connector object.

Returns:

Returns a reference to this object so that method calls can be chained together.

as2Config

default UpdateConnectorRequest.Builder as2Config(Consumer<As2ConnectorConfig.Builder> as2Config)

A structure that contains the parameters for a connector object.

This is a convenience method that creates an instance of the As2ConnectorConfig.Builder avoiding the need to create one manually via As2ConnectorConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to as2Config(As2ConnectorConfig).

Parameters:

as2Config - a consumer that will call methods on As2ConnectorConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

as2Config(As2ConnectorConfig)

accessRole

UpdateConnectorRequest.Builder accessRole(String accessRole)

With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

Parameters:

accessRole - With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/ ) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

Returns:

Returns a reference to this object so that method calls can be chained together.

loggingRole

UpdateConnectorRequest.Builder loggingRole(String loggingRole)

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.

Parameters:

loggingRole - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

UpdateConnectorRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateConnectorRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder