software.amazon.awssdk.services.transfer.model

Interface DescribedAgreement.Builder

All Superinterfaces:

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

Enclosing class:

DescribedAgreement

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

Method Summary

Modifier and Type	Method and Description
DescribedAgreement.Builder	accessRole(String accessRole) Connectors are used to send files using either the AS2 or SFTP protocol.
DescribedAgreement.Builder	agreementId(String agreementId) A unique identifier for the agreement.
DescribedAgreement.Builder	arn(String arn) The unique Amazon Resource Name (ARN) for the agreement.
DescribedAgreement.Builder	baseDirectory(String baseDirectory) The landing directory (folder) for files that are transferred by using the AS2 protocol.
DescribedAgreement.Builder	description(String description) The name or short description that's used to identify the agreement.
DescribedAgreement.Builder	localProfileId(String localProfileId) A unique identifier for the AS2 local profile.
DescribedAgreement.Builder	partnerProfileId(String partnerProfileId) A unique identifier for the partner profile used in the agreement.
DescribedAgreement.Builder	serverId(String serverId) A system-assigned unique identifier for a server instance.
DescribedAgreement.Builder	status(AgreementStatusType status) The current status of the agreement, either ACTIVE or INACTIVE.
DescribedAgreement.Builder	status(String status) The current status of the agreement, either ACTIVE or INACTIVE.
DescribedAgreement.Builder	tags(Collection<Tag> tags) Key-value pairs that can be used to group and search for agreements.
DescribedAgreement.Builder	tags(Consumer<Tag.Builder>... tags) Key-value pairs that can be used to group and search for agreements.
DescribedAgreement.Builder	tags(Tag... tags) Key-value pairs that can be used to group and search for agreements.

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

DescribedAgreement.Builder arn(String arn)

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

Parameters:

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

Returns:

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

agreementId

DescribedAgreement.Builder agreementId(String agreementId)

A unique identifier for the agreement. This identifier is returned when you create an agreement.

Parameters:

agreementId - A unique identifier for the agreement. This identifier is returned when you create an agreement.

Returns:

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

description

DescribedAgreement.Builder description(String description)

The name or short description that's used to identify the agreement.

Parameters:

description - The name or short description that's used to identify the agreement.

Returns:

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

status

DescribedAgreement.Builder status(String status)

The current status of the agreement, either ACTIVE or INACTIVE.

Parameters:

status - The current status of the agreement, either ACTIVE or INACTIVE.

Returns:

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

See Also:

AgreementStatusType, AgreementStatusType

status

DescribedAgreement.Builder status(AgreementStatusType status)

The current status of the agreement, either ACTIVE or INACTIVE.

Parameters:

status - The current status of the agreement, either ACTIVE or INACTIVE.

Returns:

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

See Also:

AgreementStatusType, AgreementStatusType

serverId

DescribedAgreement.Builder serverId(String serverId)

A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.

Parameters:

serverId - A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.

Returns:

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

localProfileId

DescribedAgreement.Builder localProfileId(String localProfileId)

A unique identifier for the AS2 local profile.

Parameters:

localProfileId - A unique identifier for the AS2 local profile.

Returns:

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

partnerProfileId

DescribedAgreement.Builder partnerProfileId(String partnerProfileId)

A unique identifier for the partner profile used in the agreement.

Parameters:

partnerProfileId - A unique identifier for the partner profile used in the agreement.

Returns:

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

baseDirectory

DescribedAgreement.Builder baseDirectory(String baseDirectory)

The landing directory (folder) for files that are transferred by using the AS2 protocol.

Parameters:

baseDirectory - The landing directory (folder) for files that are transferred by using the AS2 protocol.

Returns:

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

accessRole

DescribedAgreement.Builder accessRole(String accessRole)

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

For AS2 connectors

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.

If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

For SFTP connectors

Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

Parameters:

accessRole - Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

For AS2 connectors

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.

If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

For SFTP connectors

Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

Returns:

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

tags

DescribedAgreement.Builder tags(Collection<Tag> tags)

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

Parameters:

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

Returns:

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

tags

DescribedAgreement.Builder tags(Tag... tags)

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

Parameters:

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

Returns:

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

tags

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

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

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)