Interface UpdateConnectorRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateConnectorRequest.Builder,
,UpdateConnectorRequest> SdkBuilder<UpdateConnectorRequest.Builder,
,UpdateConnectorRequest> SdkPojo
,SdkRequest.Builder
,TransferRequest.Builder
- Enclosing class:
UpdateConnectorRequest
-
Method Summary
Modifier and TypeMethodDescriptionaccessRole
(String accessRole) Connectors are used to send files using either the AS2 or SFTP protocol.default UpdateConnectorRequest.Builder
as2Config
(Consumer<As2ConnectorConfig.Builder> as2Config) A structure that contains the parameters for an AS2 connector object.as2Config
(As2ConnectorConfig as2Config) A structure that contains the parameters for an AS2 connector object.connectorId
(String connectorId) The unique identifier for the connector.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.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.securityPolicyName
(String securityPolicyName) Specifies the name of the security policy for the connector.default UpdateConnectorRequest.Builder
sftpConfig
(Consumer<SftpConnectorConfig.Builder> sftpConfig) A structure that contains the parameters for an SFTP connector object.sftpConfig
(SftpConnectorConfig sftpConfig) A structure that contains the parameters for an SFTP connector object.The URL of the partner's AS2 or SFTP endpoint.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.transfer.model.TransferRequest.Builder
build
-
Method Details
-
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
The URL of the partner's AS2 or SFTP endpoint.
- Parameters:
url
- The URL of the partner's AS2 or SFTP endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
as2Config
A structure that contains the parameters for an AS2 connector object.
- Parameters:
as2Config
- A structure that contains the parameters for an AS2 connector object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 viaAs2ConnectorConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toas2Config(As2ConnectorConfig)
.- Parameters:
as2Config
- a consumer that will call methods onAs2ConnectorConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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, theAccessRole
needs to provide read and write access to the parent directory of the file location used in theStartFileTransfer
request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send withStartFileTransfer
.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 thekms: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 providessecretsmanager: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, theAccessRole
needs to provide read and write access to the parent directory of the file location used in theStartFileTransfer
request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send withStartFileTransfer
.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 thekms: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 providessecretsmanager:GetSecretValue
permission to Secrets Manager.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
sftpConfig
A structure that contains the parameters for an SFTP connector object.
- Parameters:
sftpConfig
- A structure that contains the parameters for an SFTP connector object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 viaSftpConnectorConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosftpConfig(SftpConnectorConfig)
.- Parameters:
sftpConfig
- a consumer that will call methods onSftpConnectorConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
securityPolicyName
Specifies the name of the security policy for the connector.
- Parameters:
securityPolicyName
- Specifies the name of the security policy for the connector.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
UpdateConnectorRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateConnectorRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-