Interface DescribedConnector.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DescribedConnector.Builder,
,DescribedConnector> SdkBuilder<DescribedConnector.Builder,
,DescribedConnector> SdkPojo
- Enclosing class:
DescribedConnector
-
Method Summary
Modifier and TypeMethodDescriptionaccessRole
(String accessRole) Connectors are used to send files using either the AS2 or SFTP protocol.The unique Amazon Resource Name (ARN) for the connector.default DescribedConnector.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.default DescribedConnector.Builder
egressConfig
(Consumer<DescribedConnectorEgressConfig.Builder> egressConfig) Current egress configuration of the connector, showing how traffic is routed to the SFTP server.egressConfig
(DescribedConnectorEgressConfig egressConfig) Current egress configuration of the connector, showing how traffic is routed to the SFTP server.egressType
(String egressType) Type of egress configuration for the connector.egressType
(ConnectorEgressType egressType) Type of egress configuration for the connector.errorMessage
(String errorMessage) Error message providing details when the connector is in ERRORED status.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.securityPolicyName
(String securityPolicyName) The text name of the security policy for the specified connector.serviceManagedEgressIpAddresses
(String... serviceManagedEgressIpAddresses) The list of egress IP addresses of this connector.serviceManagedEgressIpAddresses
(Collection<String> serviceManagedEgressIpAddresses) The list of egress IP addresses of this connector.default DescribedConnector.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.Current status of the connector.status
(ConnectorStatus status) Current status of the connector.tags
(Collection<Tag> tags) Key-value pairs that can be used to group and search for connectors.tags
(Consumer<Tag.Builder>... tags) Key-value pairs that can be used to group and search for connectors.Key-value pairs that can be used to group and search for connectors.The URL of the partner's AS2 or SFTP endpoint.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, sdkFieldNameToField, sdkFields
-
Method Details
-
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
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.
When creating AS2 connectors or service-managed SFTP connectors (connectors without egress configuration), you must provide a URL to specify the remote server endpoint. For VPC Lattice type connectors, the URL must be null.
- Parameters:
url
- The URL of the partner's AS2 or SFTP endpoint.When creating AS2 connectors or service-managed SFTP connectors (connectors without egress configuration), you must provide a URL to specify the remote server endpoint. For VPC Lattice type connectors, the URL must be null.
- 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.
-
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
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
Key-value pairs that can be used to group and search for connectors.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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:
-
serviceManagedEgressIpAddresses
DescribedConnector.Builder serviceManagedEgressIpAddresses(Collection<String> serviceManagedEgressIpAddresses) The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
- Parameters:
serviceManagedEgressIpAddresses
- The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serviceManagedEgressIpAddresses
DescribedConnector.Builder serviceManagedEgressIpAddresses(String... serviceManagedEgressIpAddresses) The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
- Parameters:
serviceManagedEgressIpAddresses
- The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityPolicyName
The text name of the security policy for the specified connector.
- Parameters:
securityPolicyName
- The text name of the security policy for the specified connector.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
egressConfig
Current egress configuration of the connector, showing how traffic is routed to the SFTP server. Contains VPC Lattice settings when using VPC_LATTICE egress type.
When using the VPC_LATTICE egress type, Transfer Family uses a managed Service Network to simplify the resource sharing process.
- Parameters:
egressConfig
- Current egress configuration of the connector, showing how traffic is routed to the SFTP server. Contains VPC Lattice settings when using VPC_LATTICE egress type.When using the VPC_LATTICE egress type, Transfer Family uses a managed Service Network to simplify the resource sharing process.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
egressConfig
default DescribedConnector.Builder egressConfig(Consumer<DescribedConnectorEgressConfig.Builder> egressConfig) Current egress configuration of the connector, showing how traffic is routed to the SFTP server. Contains VPC Lattice settings when using VPC_LATTICE egress type.
When using the VPC_LATTICE egress type, Transfer Family uses a managed Service Network to simplify the resource sharing process.
This is a convenience method that creates an instance of theDescribedConnectorEgressConfig.Builder
avoiding the need to create one manually viaDescribedConnectorEgressConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toegressConfig(DescribedConnectorEgressConfig)
.- Parameters:
egressConfig
- a consumer that will call methods onDescribedConnectorEgressConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
egressType
Type of egress configuration for the connector. SERVICE_MANAGED uses Transfer Family managed NAT gateways, while VPC_LATTICE routes traffic through customer VPCs using VPC Lattice.
- Parameters:
egressType
- Type of egress configuration for the connector. SERVICE_MANAGED uses Transfer Family managed NAT gateways, while VPC_LATTICE routes traffic through customer VPCs using VPC Lattice.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
egressType
Type of egress configuration for the connector. SERVICE_MANAGED uses Transfer Family managed NAT gateways, while VPC_LATTICE routes traffic through customer VPCs using VPC Lattice.
- Parameters:
egressType
- Type of egress configuration for the connector. SERVICE_MANAGED uses Transfer Family managed NAT gateways, while VPC_LATTICE routes traffic through customer VPCs using VPC Lattice.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
errorMessage
Error message providing details when the connector is in ERRORED status. Contains information to help troubleshoot connector creation or operation failures.
- Parameters:
errorMessage
- Error message providing details when the connector is in ERRORED status. Contains information to help troubleshoot connector creation or operation failures.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
Current status of the connector. PENDING indicates creation/update in progress, ACTIVE means ready for operations, and ERRORED indicates a failure requiring attention.
- Parameters:
status
- Current status of the connector. PENDING indicates creation/update in progress, ACTIVE means ready for operations, and ERRORED indicates a failure requiring attention.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
Current status of the connector. PENDING indicates creation/update in progress, ACTIVE means ready for operations, and ERRORED indicates a failure requiring attention.
- Parameters:
status
- Current status of the connector. PENDING indicates creation/update in progress, ACTIVE means ready for operations, and ERRORED indicates a failure requiring attention.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-