Interface DescribedConnector.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DescribedConnector.Builder,DescribedConnector>, SdkBuilder<DescribedConnector.Builder,DescribedConnector>, SdkPojo
Enclosing class:
DescribedConnector
@Mutable @NotThreadSafe public static interface DescribedConnector.Builder extends SdkPojo, CopyableBuilder<DescribedConnector.Builder,DescribedConnector>

  • Method Details

    • arn

      DescribedConnector.Builder arn(String 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

      DescribedConnector.Builder connectorId(String 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

      DescribedConnector.Builder url(String 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

      DescribedConnector.Builder as2Config(As2ConnectorConfig 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

      default DescribedConnector.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 the As2ConnectorConfig.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).

      Parameters:
      as2Config - a consumer that will call methods on As2ConnectorConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • accessRole

      DescribedConnector.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.

    • loggingRole

      DescribedConnector.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.

      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

      DescribedConnector.Builder tags(Collection<Tag> 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

      DescribedConnector.Builder tags(Tag... 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

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

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

      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<Tag>).

      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:

    • sftpConfig

      DescribedConnector.Builder sftpConfig(SftpConnectorConfig 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

      default DescribedConnector.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 the SftpConnectorConfig.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).

      Parameters:
      sftpConfig - a consumer that will call methods on SftpConnectorConfig.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

      DescribedConnector.Builder securityPolicyName(String 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

      DescribedConnector.Builder egressConfig(DescribedConnectorEgressConfig 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 the DescribedConnectorEgressConfig.Builder avoiding the need to create one manually via DescribedConnectorEgressConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to egressConfig(DescribedConnectorEgressConfig).

      Parameters:
      egressConfig - a consumer that will call methods on DescribedConnectorEgressConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • egressType

      DescribedConnector.Builder egressType(String 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

      DescribedConnector.Builder egressType(ConnectorEgressType 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

      DescribedConnector.Builder errorMessage(String 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

      DescribedConnector.Builder status(String 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

      DescribedConnector.Builder status(ConnectorStatus 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: