Package software.amazon.awscdk.services.transfer

Class CfnConnectorProps.Builder

java.lang.Object
software.amazon.awscdk.services.transfer.CfnConnectorProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnConnectorProps>
Enclosing interface:
CfnConnectorProps
@Stability(Stable) public static final class CfnConnectorProps.Builder extends Object implements software.amazon.jsii.Builder<CfnConnectorProps>
A builder for CfnConnectorProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • accessRole

      @Stability(Stable) public CfnConnectorProps.Builder accessRole(String accessRole)
      Sets the value of CfnConnectorProps.getAccessRole()
      Parameters:
      accessRole - Connectors are used to send files using either the AS2 or SFTP protocol. This parameter is required. For the access role, provide the Amazon Resource Name (ARN) of the AWS 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 AWS 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 AWS Secrets Manager .

      Returns:
      this

    • url

      @Stability(Stable) public CfnConnectorProps.Builder url(String url)
      Sets the value of CfnConnectorProps.getUrl()
      Parameters:
      url - The URL of the partner's AS2 or SFTP endpoint. This parameter is required.
      Returns:
      this

    • as2Config

      @Stability(Stable) public CfnConnectorProps.Builder as2Config(Object as2Config)
      Sets the value of CfnConnectorProps.getAs2Config()
      Parameters:
      as2Config - A structure that contains the parameters for an AS2 connector object.
      Returns:
      this

    • loggingRole

      @Stability(Stable) public CfnConnectorProps.Builder loggingRole(String loggingRole)
      Sets the value of CfnConnectorProps.getLoggingRole()
      Parameters:
      loggingRole - The Amazon Resource Name (ARN) of the AWS 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:
      this

    • securityPolicyName

      @Stability(Stable) public CfnConnectorProps.Builder securityPolicyName(String securityPolicyName)
      Sets the value of CfnConnectorProps.getSecurityPolicyName()
      Parameters:
      securityPolicyName - The text name of the security policy for the specified connector.
      Returns:
      this

    • sftpConfig

      @Stability(Stable) public CfnConnectorProps.Builder sftpConfig(IResolvable sftpConfig)
      Sets the value of CfnConnectorProps.getSftpConfig()
      Parameters:
      sftpConfig - A structure that contains the parameters for an SFTP connector object.
      Returns:
      this

    • sftpConfig

      @Stability(Stable) public CfnConnectorProps.Builder sftpConfig(CfnConnector.SftpConfigProperty sftpConfig)
      Sets the value of CfnConnectorProps.getSftpConfig()
      Parameters:
      sftpConfig - A structure that contains the parameters for an SFTP connector object.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnConnectorProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnConnectorProps.getTags()
      Parameters:
      tags - Key-value pairs that can be used to group and search for connectors.
      Returns:
      this

    • build

      @Stability(Stable) public CfnConnectorProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnConnectorProps>
      Returns:
      a new instance of CfnConnectorProps
      Throws:
      NullPointerException - if any required attribute was not provided