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(value=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 and Description
CfnLocationObjectStorage.Builder	accessKey(String accessKey) Specifies the access key (or user name) if credentials are required to access the object storage server.
CfnLocationObjectStorage.Builder	agentArns(List<String> agentArns) Specifies the Amazon Resource Names (ARNs) of the agents associated with the location.
CfnLocationObjectStorage.Builder	bucketName(String bucketName) Specifies the name of the bucket that DataSync reads from or writes to.
CfnLocationObjectStorage	build()
static CfnLocationObjectStorage.Builder	create(software.constructs.Construct scope, String id)
CfnLocationObjectStorage.Builder	secretKey(String secretKey) Specifies the secret key (or password) if credentials are required to access the object storage server.
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.
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 that DataSync reads from or writes to.
CfnLocationObjectStorage.Builder	tags(List<? extends CfnTag> tags) Specifies the key-value pair that represents the tag to help you manage, filter, and search for your location.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=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 - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnLocationObjectStorage.Builder.

agentArns

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

Specifies the Amazon Resource Names (ARNs) of the agents associated with the location.

Parameters:

agentArns - Specifies the Amazon Resource Names (ARNs) of the agents associated with the location. This parameter is required.

Returns:

this

bucketName

@Stability(value=Stable)
public CfnLocationObjectStorage.Builder bucketName(String bucketName)

Specifies the name of the bucket that DataSync reads from or writes to.

Parameters:

bucketName - Specifies the name of the bucket that DataSync reads from or writes to. This parameter is required.

Returns:

this

serverHostname

@Stability(value=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.

Parameters:

serverHostname - Specifies the domain name or IP address of the object storage server. This parameter is required.

Returns:

this

accessKey

@Stability(value=Stable)
public CfnLocationObjectStorage.Builder accessKey(String accessKey)

Specifies the access key (or user name) if credentials are required to access the object storage server.

Parameters:

accessKey - Specifies the access key (or user name) if credentials are required to access the object storage server. This parameter is required.

Returns:

this

secretKey

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

Specifies the secret key (or password) if credentials are required to access the object storage server.

Parameters:

secretKey - Specifies the secret key (or password) if credentials are required to access the object storage server. This parameter is required.

Returns:

this

serverPort

@Stability(value=Stable)
public CfnLocationObjectStorage.Builder serverPort(Number serverPort)

Specifies the port that your object storage server accepts inbound network traffic on.

Set to port 80 (HTTP), 443 (HTTPS), or a custom port if needed.

Parameters:

serverPort - Specifies the port that your object storage server accepts inbound network traffic on. This parameter is required.

Returns:

this

serverProtocol

@Stability(value=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

subdirectory

@Stability(value=Stable)
public CfnLocationObjectStorage.Builder subdirectory(String subdirectory)

Specifies the object prefix that DataSync reads from or writes to.

Parameters:

subdirectory - Specifies the object prefix that DataSync reads from or writes to. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnLocationObjectStorage.Builder tags(List<? extends CfnTag> tags)

Specifies the key-value pair that represents the tag to help you manage, filter, and search for your location.

We recommend using tags for naming your locations.

Parameters:

tags - Specifies the key-value pair that represents the tag to help you manage, filter, and search for your location. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnLocationObjectStorage build()

Specified by:

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