Interface CfnLocationObjectStorageProps

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.204Z") @Stability(Stable) public interface CfnLocationObjectStorageProps extends
Properties for defining a CfnLocationObjectStorage.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CfnLocationObjectStorageProps cfnLocationObjectStorageProps = CfnLocationObjectStorageProps.builder()
         // the properties below are optional
  • Method Details

    • getAgentArns

      @Stability(Stable) @NotNull List<String> getAgentArns()
      Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.
    • getAccessKey

      @Stability(Stable) @Nullable default String getAccessKey()
      Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
    • getBucketName

      @Stability(Stable) @Nullable default String getBucketName()
      Specifies the name of the object storage bucket involved in the transfer.
    • getSecretKey

      @Stability(Stable) @Nullable default String getSecretKey()
      Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
    • getServerCertificate

      @Stability(Stable) @Nullable default String getServerCertificate()
      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 .

    • getServerHostname

      @Stability(Stable) @Nullable default String getServerHostname()
      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.

    • getServerPort

      @Stability(Stable) @Nullable default Number getServerPort()
      Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
    • getServerProtocol

      @Stability(Stable) @Nullable default String getServerProtocol()
      Specifies the protocol that your object storage server uses to communicate.
    • getSubdirectory

      @Stability(Stable) @Nullable default String getSubdirectory()
      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.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      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.

    • builder

      @Stability(Stable) static CfnLocationObjectStorageProps.Builder builder()
      a CfnLocationObjectStorageProps.Builder of CfnLocationObjectStorageProps