public static interface CreateConnectorRequest.Builder extends TransferRequest.Builder, SdkPojo, CopyableBuilder<CreateConnectorRequest.Builder,CreateConnectorRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateConnectorRequest.Builder |
accessRole(String accessRole)
Connectors are used to send files using either the AS2 or SFTP protocol.
|
CreateConnectorRequest.Builder |
as2Config(As2ConnectorConfig as2Config)
A structure that contains the parameters for an AS2 connector object.
|
default CreateConnectorRequest.Builder |
as2Config(Consumer<As2ConnectorConfig.Builder> as2Config)
A structure that contains the parameters for an AS2 connector object.
|
CreateConnectorRequest.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.
|
CreateConnectorRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateConnectorRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
default CreateConnectorRequest.Builder |
sftpConfig(Consumer<SftpConnectorConfig.Builder> sftpConfig)
A structure that contains the parameters for an SFTP connector object.
|
CreateConnectorRequest.Builder |
sftpConfig(SftpConnectorConfig sftpConfig)
A structure that contains the parameters for an SFTP connector object.
|
CreateConnectorRequest.Builder |
tags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for connectors.
|
CreateConnectorRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
Key-value pairs that can be used to group and search for connectors.
|
CreateConnectorRequest.Builder |
tags(Tag... tags)
Key-value pairs that can be used to group and search for connectors.
|
CreateConnectorRequest.Builder |
url(String url)
The URL of the partner's AS2 or SFTP endpoint.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateConnectorRequest.Builder url(String url)
The URL of the partner's AS2 or SFTP endpoint.
url - The URL of the partner's AS2 or SFTP endpoint.CreateConnectorRequest.Builder as2Config(As2ConnectorConfig as2Config)
A structure that contains the parameters for an AS2 connector object.
as2Config - A structure that contains the parameters for an AS2 connector object.default CreateConnectorRequest.Builder as2Config(Consumer<As2ConnectorConfig.Builder> as2Config)
A structure that contains the parameters for an AS2 connector object.
This is a convenience method that creates an instance of theAs2ConnectorConfig.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).
as2Config - a consumer that will call methods on As2ConnectorConfig.Builderas2Config(As2ConnectorConfig)CreateConnectorRequest.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.
CreateConnectorRequest.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.
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.CreateConnectorRequest.Builder tags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
tags - Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to
connectors for any purpose.CreateConnectorRequest.Builder tags(Tag... tags)
Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
tags - Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to
connectors for any purpose.CreateConnectorRequest.Builder tags(Consumer<Tag.Builder>... tags)
Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
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) CreateConnectorRequest.Builder sftpConfig(SftpConnectorConfig sftpConfig)
A structure that contains the parameters for an SFTP connector object.
sftpConfig - A structure that contains the parameters for an SFTP connector object.default CreateConnectorRequest.Builder sftpConfig(Consumer<SftpConnectorConfig.Builder> sftpConfig)
A structure that contains the parameters for an SFTP connector object.
This is a convenience method that creates an instance of theSftpConnectorConfig.Builder avoiding the
need to create one manually via SftpConnectorConfig.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to sftpConfig(SftpConnectorConfig).
sftpConfig - a consumer that will call methods on SftpConnectorConfig.BuildersftpConfig(SftpConnectorConfig)CreateConnectorRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateConnectorRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.