Class CreateLocationObjectStorageRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.datasync.model.DataSyncRequest
software.amazon.awssdk.services.datasync.model.CreateLocationObjectStorageRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateLocationObjectStorageRequest.Builder,CreateLocationObjectStorageRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateLocationObjectStorageRequest extends DataSyncRequest implements ToCopyableBuilder<CreateLocationObjectStorageRequest.Builder,CreateLocationObjectStorageRequest>

CreateLocationObjectStorageRequest

  • Method Details

    • serverHostname

      public final String serverHostname()

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

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

    • serverPort

      public final Integer serverPort()

      Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

      Returns:
      Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

    • serverProtocol

      public final ObjectStorageServerProtocol serverProtocol()

      Specifies the protocol that your object storage server uses to communicate. If not specified, the default value is HTTPS.

      If the service returns an enum value that is not available in the current SDK version, serverProtocol will return ObjectStorageServerProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serverProtocolAsString().

      Returns:
      Specifies the protocol that your object storage server uses to communicate. If not specified, the default value is HTTPS.
      See Also:

    • serverProtocolAsString

      public final String serverProtocolAsString()

      Specifies the protocol that your object storage server uses to communicate. If not specified, the default value is HTTPS.

      If the service returns an enum value that is not available in the current SDK version, serverProtocol will return ObjectStorageServerProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serverProtocolAsString().

      Returns:
      Specifies the protocol that your object storage server uses to communicate. If not specified, the default value is HTTPS.
      See Also:

    • subdirectory

      public final 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.

      Returns:
      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.

    • bucketName

      public final String bucketName()

      Specifies the name of the object storage bucket involved in the transfer.

      Returns:
      Specifies the name of the object storage bucket involved in the transfer.

    • accessKey

      public final String accessKey()

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

      Returns:
      Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

    • secretKey

      public final 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.

      Returns:
      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.

    • hasAgentArns

      public final boolean hasAgentArns()
      For responses, this returns true if the service returned a value for the AgentArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • agentArns

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAgentArns() method.

      Returns:
      (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.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      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.

    • serverCertificate

      public final 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.

      Returns:
      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.

    • cmkSecretConfig

      public final 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 paramater 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 the 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:
      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 paramater 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 the 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.

    • customSecretConfig

      public final 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. 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:
      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. 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.

    • toBuilder

      public CreateLocationObjectStorageRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateLocationObjectStorageRequest.Builder,CreateLocationObjectStorageRequest>
      Specified by:
      toBuilder in class DataSyncRequest
      Returns:
      a builder for type T

    • builder

      public static CreateLocationObjectStorageRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateLocationObjectStorageRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.