software.amazon.awssdk.services.transfer.model

Interface DescribedConnector.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DescribedConnector.Builder,DescribedConnector>, SdkBuilder<DescribedConnector.Builder,DescribedConnector>, SdkPojo

Enclosing class:

DescribedConnector

public static interface DescribedConnector.Builder
extends SdkPojo, CopyableBuilder<DescribedConnector.Builder,DescribedConnector>

Method Summary

Modifier and Type	Method and Description
DescribedConnector.Builder	accessRole(String accessRole) With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths.
DescribedConnector.Builder	arn(String arn) The unique Amazon Resource Name (ARN) for the connector.
DescribedConnector.Builder	as2Config(As2ConnectorConfig as2Config) A structure that contains the parameters for a connector object.
default DescribedConnector.Builder	as2Config(Consumer<As2ConnectorConfig.Builder> as2Config) A structure that contains the parameters for a connector object.
DescribedConnector.Builder	connectorId(String connectorId) The unique identifier for the connector.
DescribedConnector.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.
DescribedConnector.Builder	tags(Collection<Tag> tags) Key-value pairs that can be used to group and search for connectors.
DescribedConnector.Builder	tags(Consumer<Tag.Builder>... tags) Key-value pairs that can be used to group and search for connectors.
DescribedConnector.Builder	tags(Tag... tags) Key-value pairs that can be used to group and search for connectors.
DescribedConnector.Builder	url(String url) The URL of the partner's AS2 endpoint.

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

arn

DescribedConnector.Builder arn(String arn)

The unique Amazon Resource Name (ARN) for the connector.

Parameters:

arn - The unique Amazon Resource Name (ARN) for the connector.

Returns:

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

connectorId

DescribedConnector.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

DescribedConnector.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

DescribedConnector.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 DescribedConnector.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

DescribedConnector.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

DescribedConnector.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.

tags

DescribedConnector.Builder tags(Collection<Tag> tags)

Key-value pairs that can be used to group and search for connectors.

Parameters:

tags - Key-value pairs that can be used to group and search for connectors.

Returns:

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

tags

DescribedConnector.Builder tags(Tag... tags)

Key-value pairs that can be used to group and search for connectors.

Parameters:

tags - Key-value pairs that can be used to group and search for connectors.

Returns:

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

tags

DescribedConnector.Builder tags(Consumer<Tag.Builder>... tags)

Key-value pairs that can be used to group and search for connectors.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#tags(java.util.Collection)