Interface CreateLocationObjectStorageRequest.Builder

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

  • Method Details

    • serverHostname

      CreateLocationObjectStorageRequest.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. A DataSync agent uses this hostname to mount the object storage server in a network.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serverPort

      CreateLocationObjectStorageRequest.Builder serverPort(Integer 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).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serverProtocol

      CreateLocationObjectStorageRequest.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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • serverProtocol

      CreateLocationObjectStorageRequest.Builder serverProtocol(ObjectStorageServerProtocol 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • subdirectory

      CreateLocationObjectStorageRequest.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. 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bucketName

      CreateLocationObjectStorageRequest.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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accessKey

      CreateLocationObjectStorageRequest.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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secretKey

      CreateLocationObjectStorageRequest.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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • agentArns

      CreateLocationObjectStorageRequest.Builder agentArns(Collection<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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • agentArns

      CreateLocationObjectStorageRequest.Builder agentArns(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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateLocationObjectStorageRequest.Builder tags(Collection<TagListEntry> 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. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateLocationObjectStorageRequest.Builder tags(TagListEntry... 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. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateLocationObjectStorageRequest.Builder tags(Consumer<TagListEntry.Builder>... 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.

      This is a convenience method that creates an instance of the TagListEntry.Builder avoiding the need to create one manually via TagListEntry.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<TagListEntry>).

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

    • serverCertificate

      CreateLocationObjectStorageRequest.Builder serverCertificate(SdkBytes serverCertificate)

      Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA). You must specify a single .pem file with a full certificate chain (for example, file:///home/user/.ssh/object_storage_certificates.pem).

      The certificate chain might include:

      • The object storage system's certificate

      • All intermediate certificates (if there are any)

      • The root certificate of the signing CA

      You can concatenate your certificates into a .pem file (which can be up to 32768 bytes before base64 encoding). The following example cat command creates an object_storage_certificates.pem file that includes three certificates:

      cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem

      To use this parameter, configure ServerProtocol to HTTPS.

      Parameters:
      serverCertificate - Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA). You must specify a single .pem file with a full certificate chain (for example, file:///home/user/.ssh/object_storage_certificates.pem).

      The certificate chain might include:

      • The object storage system's certificate

      • All intermediate certificates (if there are any)

      • The root certificate of the signing CA

      You can concatenate your certificates into a .pem file (which can be up to 32768 bytes before base64 encoding). The following example cat command creates an object_storage_certificates.pem file that includes three certificates:

      cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem

      To use this parameter, configure ServerProtocol to HTTPS.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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