Package software.amazon.awscdk.services.datasync

Interface CfnLocationObjectStorageProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLocationObjectStorageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-07-29T17:50:58.326Z")
@Stability(Stable)
public interface CfnLocationObjectStorageProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnLocationObjectStorage.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.datasync.*;
 CfnLocationObjectStorageProps cfnLocationObjectStorageProps = CfnLocationObjectStorageProps.builder()
         .accessKey("accessKey")
         .agentArns(List.of("agentArns"))
         .bucketName("bucketName")
         .cmkSecretConfig(CmkSecretConfigProperty.builder()
                 .kmsKeyArn("kmsKeyArn")
                 .secretArn("secretArn")
                 .build())
         .customSecretConfig(CustomSecretConfigProperty.builder()
                 .secretAccessRoleArn("secretAccessRoleArn")
                 .secretArn("secretArn")
                 .build())
         .secretKey("secretKey")
         .serverCertificate("serverCertificate")
         .serverHostname("serverHostname")
         .serverPort(123)
         .serverProtocol("serverProtocol")
         .subdirectory("subdirectory")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnLocationObjectStorageProps.Builder	A builder for CfnLocationObjectStorageProps
static final class	CfnLocationObjectStorageProps.Jsii$Proxy	An implementation for CfnLocationObjectStorageProps

Method Summary

Modifier and Type	Method	Description
static CfnLocationObjectStorageProps.Builder	builder()
default String	getAccessKey()	Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
default List<String>	getAgentArns()	(Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.
default String	getBucketName()	Specifies the name of the object storage bucket involved in the transfer.
default Object	getCmkSecretConfig()	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 AWS KMS key .
default Object	getCustomSecretConfig()	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.
default String	getSecretKey()	Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
default String	getServerCertificate()	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).
default String	getServerHostname()	Specifies the domain name or IP address (IPv4 or IPv6) of the object storage server that your DataSync agent connects to.
default Number	getServerPort()	Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
default String	getServerProtocol()	Specifies the protocol that your object storage server uses to communicate.
default String	getSubdirectory()	Specifies the object prefix for your object storage server.
default List<CfnTag>	getTags()	Specifies the key-value pair that represents a tag that you want to add to the resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-accesskey

getAgentArns

@Stability(Stable)
@Nullable
default List<String> getAgentArns()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-agentarns

getBucketName

@Stability(Stable)
@Nullable
default String getBucketName()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-bucketname

getCmkSecretConfig

@Stability(Stable)
@Nullable
default Object getCmkSecretConfig()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-cmksecretconfig

getCustomSecretConfig

@Stability(Stable)
@Nullable
default Object getCustomSecretConfig()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-customsecretconfig

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.

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 AWS account's Secrets Manager secret.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-secretkey

getServerCertificate

@Stability(Stable)
@Nullable
default String getServerCertificate()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-servercertificate

getServerHostname

@Stability(Stable)
@Nullable
default String getServerHostname()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-serverhostname

getServerPort

@Stability(Stable)
@Nullable
default Number getServerPort()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-serverport

getServerProtocol

@Stability(Stable)
@Nullable
default String getServerProtocol()

Specifies the protocol that your object storage server uses to communicate.

If not specified, the default value is HTTPS .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-serverprotocol

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-subdirectory

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-tags

builder

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

Returns:

a CfnLocationObjectStorageProps.Builder of CfnLocationObjectStorageProps