Package software.amazon.awssdk.services.transfer.model

Interface CreateConnectorRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateConnectorRequest.Builder,CreateConnectorRequest>, SdkBuilder<CreateConnectorRequest.Builder,CreateConnectorRequest>, SdkPojo, SdkRequest.Builder, TransferRequest.Builder
Enclosing class:
CreateConnectorRequest
public static interface CreateConnectorRequest.Builder extends TransferRequest.Builder, SdkPojo, CopyableBuilder<CreateConnectorRequest.Builder,CreateConnectorRequest>

  • Method Details

    • url

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

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

      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.

      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

      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.

      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

      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.

      Parameters:
      tags - Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      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.

      Parameters:
      tags - Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

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

      CreateConnectorRequest.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 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 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:

    • securityPolicyName

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

      CreateConnectorRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateConnectorRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.