Package software.amazon.awscdk.services.datasync

Class CfnLocationObjectStorage.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static CfnLocationObjectStorage.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnLocationObjectStorage.Builder.

    • agentArns

      @Stability(Stable) public CfnLocationObjectStorage.Builder agentArns(List<String> agentArns)
      Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.

      Parameters:
      agentArns - Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location. This parameter is required.
      Returns:
      this

    • accessKey

      @Stability(Stable) public CfnLocationObjectStorage.Builder accessKey(String accessKey)
      Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

      Parameters:
      accessKey - Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server. This parameter is required.
      Returns:
      this

    • bucketName

      @Stability(Stable) public CfnLocationObjectStorage.Builder bucketName(String bucketName)
      Specifies the name of the object storage bucket involved in the transfer.

      Parameters:
      bucketName - Specifies the name of the object storage bucket involved in the transfer. This parameter is required.
      Returns:
      this

    • secretKey

      @Stability(Stable) public CfnLocationObjectStorage.Builder secretKey(String secretKey)
      Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

      Parameters:
      secretKey - Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server. This parameter is required.
      Returns:
      this

    • serverCertificate

      @Stability(Stable) public CfnLocationObjectStorage.Builder serverCertificate(String serverCertificate)
      Specifies a file with the certificates that are used to sign the object storage server's certificate (for example, file:///home/user/.ssh/storage_sys_certificate.pem ). The file you specify must include the following:.

      • The certificate of the signing certificate authority (CA)
      • Any intermediate certificates
      • base64 encoding
      • A .pem extension

      The file can be up to 32768 bytes (before base64 encoding).

      To use this parameter, configure ServerProtocol to HTTPS .

      Parameters:
      serverCertificate - Specifies a file with the certificates that are used to sign the object storage server's certificate (for example, file:///home/user/.ssh/storage_sys_certificate.pem ). The file you specify must include the following:. This parameter is required.
      Returns:
      this

    • serverHostname

      @Stability(Stable) public CfnLocationObjectStorage.Builder serverHostname(String serverHostname)
      Specifies the domain name or IP address of the object storage server.

      A DataSync agent uses this hostname to mount the object storage server in a network.

      Parameters:
      serverHostname - Specifies the domain name or IP address of the object storage server. This parameter is required.
      Returns:
      this

    • serverPort

      @Stability(Stable) public CfnLocationObjectStorage.Builder serverPort(Number serverPort)
      Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

      Parameters:
      serverPort - Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443). This parameter is required.
      Returns:
      this

    • serverProtocol

      @Stability(Stable) public CfnLocationObjectStorage.Builder serverProtocol(String serverProtocol)
      Specifies the protocol that your object storage server uses to communicate.

      Parameters:
      serverProtocol - Specifies the protocol that your object storage server uses to communicate. This parameter is required.
      Returns:
      this

    • subdirectory

      @Stability(Stable) public CfnLocationObjectStorage.Builder subdirectory(String subdirectory)
      Specifies the object prefix for your object storage server.

      If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.

      Parameters:
      subdirectory - Specifies the object prefix for your object storage server. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnLocationObjectStorage.Builder tags(List<? extends CfnTag> tags)
      Specifies the key-value pair that represents a tag that you want to add to the resource.

      Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.

      Parameters:
      tags - Specifies the key-value pair that represents a tag that you want to add to the resource. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnLocationObjectStorage build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnLocationObjectStorage>
      Returns:
      a newly built instance of CfnLocationObjectStorage.