Package software.amazon.awscdk.services.datasync

Class CfnLocationObjectStorage.Builder

java.lang.Object

software.amazon.awscdk.services.datasync.CfnLocationObjectStorage.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLocationObjectStorage>

Enclosing class:

CfnLocationObjectStorage

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

A fluent builder for CfnLocationObjectStorage.

Method Summary

Modifier and Type	Method	Description
CfnLocationObjectStorage.Builder	accessKey(String accessKey)	Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
CfnLocationObjectStorage.Builder	agentArns(List<String> agentArns)	Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.
CfnLocationObjectStorage.Builder	bucketName(String bucketName)	Specifies the name of the object storage bucket involved in the transfer.
CfnLocationObjectStorage	build()
static CfnLocationObjectStorage.Builder	create(software.constructs.Construct scope, String id)
CfnLocationObjectStorage.Builder	secretKey(String secretKey)	Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
CfnLocationObjectStorage.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).
CfnLocationObjectStorage.Builder	serverHostname(String serverHostname)	Specifies the domain name or IP address of the object storage server.
CfnLocationObjectStorage.Builder	serverPort(Number serverPort)	Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
CfnLocationObjectStorage.Builder	serverProtocol(String serverProtocol)	Specifies the protocol that your object storage server uses to communicate.
CfnLocationObjectStorage.Builder	subdirectory(String subdirectory)	Specifies the object prefix for your object storage server.
CfnLocationObjectStorage.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 CfnLocationObjectStorage.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnLocationObjectStorage.Builder.

agentArns

@Stability(Stable)
public CfnLocationObjectStorage.Builder agentArns(List<String> agentArns)

Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.

Parameters:

agentArns - 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

accessKey

@Stability(Stable)
public CfnLocationObjectStorage.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

bucketName

@Stability(Stable)
public CfnLocationObjectStorage.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

secretKey

@Stability(Stable)
public CfnLocationObjectStorage.Builder secretKey(String secretKey)

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

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 CfnLocationObjectStorage.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 CfnLocationObjectStorage.Builder serverHostname(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.

Parameters:

serverHostname - Specifies the domain name or IP address of 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-serverhostname

serverPort

@Stability(Stable)
public CfnLocationObjectStorage.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 CfnLocationObjectStorage.Builder serverProtocol(String serverProtocol)

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

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 CfnLocationObjectStorage.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 CfnLocationObjectStorage.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 CfnLocationObjectStorage build()

Specified by:

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

Returns:

a newly built instance of CfnLocationObjectStorage.