Interface UpdateLocationObjectStorageRequest.Builder

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

  • Method Details

    • locationArn

      UpdateLocationObjectStorageRequest.Builder locationArn(String locationArn)

      Specifies the ARN of the object storage system location that you're updating.

      Parameters:
      locationArn - Specifies the ARN of the object storage system location that you're updating.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serverPort

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

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

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

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

    • serverHostname

      UpdateLocationObjectStorageRequest.Builder serverHostname(String serverHostname)

      Specifies the domain name or IP address (IPv4 or IPv6) of the object storage server that your DataSync agent connects to.

      Parameters:
      serverHostname - Specifies the domain name or IP address (IPv4 or IPv6) of the object storage server that your DataSync agent connects to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accessKey

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

      UpdateLocationObjectStorageRequest.Builder secretKey(String secretKey)

      Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

      If you provide a secret using SecretKey, but do not provide secret configuration details using CmkSecretConfig or CustomSecretConfig, then DataSync stores the token using your Amazon Web Services account's Secrets Manager secret.

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

      If you provide a secret using SecretKey, but do not provide secret configuration details using CmkSecretConfig or CustomSecretConfig, then DataSync stores the token using your Amazon Web Services account's Secrets Manager secret.

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

    • agentArns

      UpdateLocationObjectStorageRequest.Builder agentArns(Collection<String> agentArns)

      (Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.

      You cannot add or remove agents from a storage location after you initially create it.

      Parameters:
      agentArns - (Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.

      You cannot add or remove agents from a storage location after you initially create it.

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

    • agentArns

      UpdateLocationObjectStorageRequest.Builder agentArns(String... agentArns)

      (Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.

      You cannot add or remove agents from a storage location after you initially create it.

      Parameters:
      agentArns - (Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.

      You cannot add or remove agents from a storage location after you initially create it.

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

    • serverCertificate

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

      Updating this parameter doesn't interfere with tasks that you have in progress.

      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.

      Updating this parameter doesn't interfere with tasks that you have in progress.

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

    • cmkSecretConfig

      UpdateLocationObjectStorageRequest.Builder cmkSecretConfig(CmkSecretConfig cmkSecretConfig)

      Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.

      Parameters:
      cmkSecretConfig - Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cmkSecretConfig

      default UpdateLocationObjectStorageRequest.Builder cmkSecretConfig(Consumer<CmkSecretConfig.Builder> cmkSecretConfig)

      Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.

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

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

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

    • customSecretConfig

      UpdateLocationObjectStorageRequest.Builder customSecretConfig(CustomSecretConfig customSecretConfig)

      Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.

      Parameters:
      customSecretConfig - Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customSecretConfig

      default UpdateLocationObjectStorageRequest.Builder customSecretConfig(Consumer<CustomSecretConfig.Builder> customSecretConfig)

      Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.

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

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

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

    • overrideConfiguration

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

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