Package software.amazon.awssdk.services.datasync.model

Interface CreateLocationObjectStorageRequest.Builder

    • Method Detail

      • serverHostname

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

      • 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. If not specified, the default value is HTTPS.

        Parameters:
        serverProtocol - Specifies the protocol that your object storage server uses to communicate. If not specified, the default value is HTTPS.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ObjectStorageServerProtocol, ObjectStorageServerProtocol

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

        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

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

        Make sure you configure this parameter correctly when you first create your storage location. You cannot add or remove agents from a storage location after you 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.

        Make sure you configure this parameter correctly when you first create your storage location. You cannot add or remove agents from a storage location after you create it.

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

      • agentArns

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

        Make sure you configure this parameter correctly when you first create your storage location. You cannot add or remove agents from a storage location after you 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.

        Make sure you configure this parameter correctly when you first create your storage location. You cannot add or remove agents from a storage location after you create it.

        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.

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

      • cmkSecretConfig

        CreateLocationObjectStorageRequest.Builder cmkSecretConfig​(CmkSecretConfig cmkSecretConfig)

        Specifies configuration information for a DataSync-managed secret, which includes the SecretKey that DataSync uses to access a specific object storage location, with a customer-managed KMS key.

        When you include this parameter as part of a CreateLocationObjectStorage request, you provide only the KMS key ARN. DataSync uses this KMS key together with the value you specify for the SecretKey parameter to create a DataSync-managed secret to store the location access credentials.

        Make sure that DataSync has permission to access the KMS key that you specify.

        You can use either CmkSecretConfig (with SecretKey) or CustomSecretConfig (without SecretKey) to provide credentials for a CreateLocationObjectStorage request. Do not provide both parameters for the same request.

        Parameters:
        cmkSecretConfig - Specifies configuration information for a DataSync-managed secret, which includes the SecretKey that DataSync uses to access a specific object storage location, with a customer-managed KMS key.

        When you include this parameter as part of a CreateLocationObjectStorage request, you provide only the KMS key ARN. DataSync uses this KMS key together with the value you specify for the SecretKey parameter to create a DataSync-managed secret to store the location access credentials.

        Make sure that DataSync has permission to access the KMS key that you specify.

        You can use either CmkSecretConfig (with SecretKey) or CustomSecretConfig (without SecretKey) to provide credentials for a CreateLocationObjectStorage request. Do not provide both parameters for the same request.

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

      • cmkSecretConfig

        default CreateLocationObjectStorageRequest.Builder cmkSecretConfig​(Consumer<CmkSecretConfig.Builder> cmkSecretConfig)

        Specifies configuration information for a DataSync-managed secret, which includes the SecretKey that DataSync uses to access a specific object storage location, with a customer-managed KMS key.

        When you include this parameter as part of a CreateLocationObjectStorage request, you provide only the KMS key ARN. DataSync uses this KMS key together with the value you specify for the SecretKey parameter to create a DataSync-managed secret to store the location access credentials.

        Make sure that DataSync has permission to access the KMS key that you specify.

        You can use either CmkSecretConfig (with SecretKey) or CustomSecretConfig (without SecretKey) to provide credentials for a CreateLocationObjectStorage request. Do not provide both parameters for the same request.

        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:
        cmkSecretConfig(CmkSecretConfig)

      • customSecretConfig

        CreateLocationObjectStorageRequest.Builder customSecretConfig​(CustomSecretConfig customSecretConfig)

        Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text, in Secrets Manager. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.

        You can use either CmkSecretConfig (with SecretKey) or CustomSecretConfig (without SecretKey) to provide credentials for a CreateLocationObjectStorage request. Do not provide both parameters for the same request.

        Parameters:
        customSecretConfig - Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text, in Secrets Manager. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.

        You can use either CmkSecretConfig (with SecretKey) or CustomSecretConfig (without SecretKey) to provide credentials for a CreateLocationObjectStorage request. Do not provide both parameters for the same request.

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