Package software.amazon.awscdk.cfnpropertymixins.services.datasync

Class CfnLocationObjectStoragePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.datasync.CfnLocationObjectStoragePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLocationObjectStoragePropsMixin>

Enclosing class:

CfnLocationObjectStoragePropsMixin

@Stability(Stable)
public static final class CfnLocationObjectStoragePropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnLocationObjectStoragePropsMixin>

A fluent builder for CfnLocationObjectStoragePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnLocationObjectStoragePropsMixin.Builder	accessKey(String accessKey)	Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
CfnLocationObjectStoragePropsMixin.Builder	agentArns(List<String> agentArns)	(Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.
CfnLocationObjectStoragePropsMixin.Builder	bucketName(String bucketName)	Specifies the name of the object storage bucket involved in the transfer.
CfnLocationObjectStoragePropsMixin	build()
CfnLocationObjectStoragePropsMixin.Builder	cmkSecretConfig(CfnLocationObjectStoragePropsMixin.CmkSecretConfigProperty 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 AWS KMS key .
CfnLocationObjectStoragePropsMixin.Builder	cmkSecretConfig(IResolvable 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 AWS KMS key .
static CfnLocationObjectStoragePropsMixin.Builder	create()
static CfnLocationObjectStoragePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnLocationObjectStoragePropsMixin.Builder	customSecretConfig(CfnLocationObjectStoragePropsMixin.CustomSecretConfigProperty 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.
CfnLocationObjectStoragePropsMixin.Builder	customSecretConfig(IResolvable 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.
CfnLocationObjectStoragePropsMixin.Builder	secretKey(String secretKey)	Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
CfnLocationObjectStoragePropsMixin.Builder	serverCertificate(String 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).
CfnLocationObjectStoragePropsMixin.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.
CfnLocationObjectStoragePropsMixin.Builder	serverPort(Number serverPort)	Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
CfnLocationObjectStoragePropsMixin.Builder	serverProtocol(String serverProtocol)	Specifies the protocol that your object storage server uses to communicate.
CfnLocationObjectStoragePropsMixin.Builder	subdirectory(String subdirectory)	Specifies the object prefix for your object storage server.
CfnLocationObjectStoragePropsMixin.Builder	tags(List<? extends CfnTag> tags)	Specifies the key-value pair that represents a tag that you want to add to the resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnLocationObjectStoragePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnLocationObjectStoragePropsMixin.Builder.

create

@Stability(Stable)
public static CfnLocationObjectStoragePropsMixin.Builder create()

Returns:

a new instance of CfnLocationObjectStoragePropsMixin.Builder.

accessKey

@Stability(Stable)
public CfnLocationObjectStoragePropsMixin.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. This parameter is required.

Returns:

this

See Also:

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

agentArns

@Stability(Stable)
public CfnLocationObjectStoragePropsMixin.Builder agentArns(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.

Parameters:

agentArns - (Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. This parameter is required.

Returns:

this

See Also:

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

bucketName

@Stability(Stable)
public CfnLocationObjectStoragePropsMixin.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. This parameter is required.

Returns:

this

See Also:

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

cmkSecretConfig

@Stability(Stable)
public CfnLocationObjectStoragePropsMixin.Builder cmkSecretConfig(IResolvable 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 AWS 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 AWS KMS key . This parameter is required.

Returns:

this

See Also:

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

cmkSecretConfig

@Stability(Stable)
public CfnLocationObjectStoragePropsMixin.Builder cmkSecretConfig(CfnLocationObjectStoragePropsMixin.CmkSecretConfigProperty 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 AWS 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 AWS KMS key . This parameter is required.

Returns:

this

See Also:

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

customSecretConfig

@Stability(Stable)
public CfnLocationObjectStoragePropsMixin.Builder customSecretConfig(IResolvable 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 parameter is required.

Returns:

this

See Also:

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

customSecretConfig

@Stability(Stable)
public CfnLocationObjectStoragePropsMixin.Builder customSecretConfig(CfnLocationObjectStoragePropsMixin.CustomSecretConfigProperty 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 parameter is required.

Returns:

this

See Also:

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

secretKey

@Stability(Stable)
public CfnLocationObjectStoragePropsMixin.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 AWS 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. This parameter is required.

Returns:

this

See Also:

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

serverCertificate

@Stability(Stable)
public CfnLocationObjectStoragePropsMixin.Builder serverCertificate(String 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). This parameter is required.

Returns:

this

See Also:

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

serverHostname

@Stability(Stable)
public CfnLocationObjectStoragePropsMixin.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. This parameter is required.

Returns:

this

See Also:

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

serverPort

@Stability(Stable)
public CfnLocationObjectStoragePropsMixin.Builder serverPort(Number 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). This parameter is required.

Returns:

this

See Also:

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

serverProtocol

@Stability(Stable)
public CfnLocationObjectStoragePropsMixin.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. This parameter is required.

Returns:

this

See Also:

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

subdirectory

@Stability(Stable)
public CfnLocationObjectStoragePropsMixin.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. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnLocationObjectStoragePropsMixin.Builder tags(List<? extends CfnTag> 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. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnLocationObjectStoragePropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnLocationObjectStoragePropsMixin>

Returns:

a newly built instance of CfnLocationObjectStoragePropsMixin.