public static interface CreateAgreementRequest.Builder extends TransferRequest.Builder, SdkPojo, CopyableBuilder<CreateAgreementRequest.Builder,CreateAgreementRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateAgreementRequest.Builder |
accessRole(String accessRole)
Connectors are used to send files using either the AS2 or SFTP protocol.
|
CreateAgreementRequest.Builder |
baseDirectory(String baseDirectory)
The landing directory (folder) for files transferred by using the AS2 protocol.
|
CreateAgreementRequest.Builder |
description(String description)
A name or short description to identify the agreement.
|
CreateAgreementRequest.Builder |
localProfileId(String localProfileId)
A unique identifier for the AS2 local profile.
|
CreateAgreementRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateAgreementRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateAgreementRequest.Builder |
partnerProfileId(String partnerProfileId)
A unique identifier for the partner profile used in the agreement.
|
CreateAgreementRequest.Builder |
serverId(String serverId)
A system-assigned unique identifier for a server instance.
|
CreateAgreementRequest.Builder |
status(AgreementStatusType status)
The status of the agreement.
|
CreateAgreementRequest.Builder |
status(String status)
The status of the agreement.
|
CreateAgreementRequest.Builder |
tags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for agreements.
|
CreateAgreementRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
Key-value pairs that can be used to group and search for agreements.
|
CreateAgreementRequest.Builder |
tags(Tag... tags)
Key-value pairs that can be used to group and search for agreements.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateAgreementRequest.Builder description(String description)
A name or short description to identify the agreement.
description - A name or short description to identify the agreement.CreateAgreementRequest.Builder serverId(String serverId)
A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.
serverId - A system-assigned unique identifier for a server instance. This is the specific server that the
agreement uses.CreateAgreementRequest.Builder localProfileId(String localProfileId)
A unique identifier for the AS2 local profile.
localProfileId - A unique identifier for the AS2 local profile.CreateAgreementRequest.Builder partnerProfileId(String partnerProfileId)
A unique identifier for the partner profile used in the agreement.
partnerProfileId - A unique identifier for the partner profile used in the agreement.CreateAgreementRequest.Builder baseDirectory(String baseDirectory)
The landing directory (folder) for files transferred by using the AS2 protocol.
A BaseDirectory example is /DOC-EXAMPLE-BUCKET/home/mydirectory.
baseDirectory - The landing directory (folder) for files transferred by using the AS2 protocol.
A BaseDirectory example is /DOC-EXAMPLE-BUCKET/home/mydirectory.
CreateAgreementRequest.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.
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.
CreateAgreementRequest.Builder status(String status)
The status of the agreement. The agreement can be either ACTIVE or INACTIVE.
status - The status of the agreement. The agreement can be either ACTIVE or INACTIVE.AgreementStatusType,
AgreementStatusTypeCreateAgreementRequest.Builder status(AgreementStatusType status)
The status of the agreement. The agreement can be either ACTIVE or INACTIVE.
status - The status of the agreement. The agreement can be either ACTIVE or INACTIVE.AgreementStatusType,
AgreementStatusTypeCreateAgreementRequest.Builder tags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for agreements.
tags - Key-value pairs that can be used to group and search for agreements.CreateAgreementRequest.Builder tags(Tag... tags)
Key-value pairs that can be used to group and search for agreements.
tags - Key-value pairs that can be used to group and search for agreements.CreateAgreementRequest.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 theTag.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.
tags - a consumer that will call methods on
Tag.Builder#tags(java.util.Collection) CreateAgreementRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateAgreementRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.