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

Class CreateLocationObjectStorageRequest

    • Method Detail

      • serverHostname

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

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

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

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

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

      • 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()

        Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with 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 hasAgentArns() method.

        Returns:
        Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.

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

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

      • 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