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) Optional.
CfnLocationObjectStorage.Builder	agentArns(List<String> agentArns) The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
CfnLocationObjectStorage.Builder	bucketName(String bucketName) The bucket on the self-managed object storage server that is used to read data from.
CfnLocationObjectStorage	build()
static CfnLocationObjectStorage.Builder	create(software.constructs.Construct scope, String id)
CfnLocationObjectStorage.Builder	secretKey(String secretKey) Optional.
CfnLocationObjectStorage.Builder	serverHostname(String serverHostname) The name of the self-managed object storage server.
CfnLocationObjectStorage.Builder	serverPort(Number serverPort) The port that your self-managed object storage server accepts inbound network traffic on.
CfnLocationObjectStorage.Builder	serverProtocol(String serverProtocol) The protocol that the object storage server uses to communicate.
CfnLocationObjectStorage.Builder	subdirectory(String subdirectory) The subdirectory in the self-managed object storage server that is used to read data from.
CfnLocationObjectStorage.Builder	tags(List<? extends CfnTag> tags) The key-value pair that represents the tag that you want to add to the 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)

The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

Parameters:

agentArns - The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location. This parameter is required.

Returns:

this

bucketName

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

The bucket on the self-managed object storage server that is used to read data from.

Parameters:

bucketName - The bucket on the self-managed object storage server that is used to read data from. This parameter is required.

Returns:

this

serverHostname

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

The name of the self-managed object storage server.

This value is the IP address or Domain Name Service (DNS) name of the object storage server. An agent uses this hostname to mount the object storage server in a network.

Parameters:

serverHostname - The name of the self-managed object storage server. This parameter is required.

Returns:

this

accessKey

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

Optional.

The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

Parameters:

accessKey - Optional. This parameter is required.

Returns:

this

secretKey

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

Optional.

The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

Parameters:

secretKey - Optional. This parameter is required.

Returns:

this

serverPort

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

The port that your self-managed object storage server accepts inbound network traffic on.

The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.

Parameters:

serverPort - The port that your self-managed object storage server accepts inbound network traffic on. This parameter is required.

Returns:

this

serverProtocol

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

The protocol that the object storage server uses to communicate.

Valid values are HTTP or HTTPS.

Parameters:

serverProtocol - The protocol that the object storage server uses to communicate. This parameter is required.

Returns:

this

subdirectory

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

The subdirectory in the self-managed object storage server that is used to read data from.

Parameters:

subdirectory - The subdirectory in the self-managed object storage server that is used to read data from. This parameter is required.

Returns:

this

tags

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

The key-value pair that represents the tag that you want to add to the location.

The value can be an empty string. We recommend using tags to name your resources.

Parameters:

tags - The key-value pair that represents the tag that you want to add to the location. This parameter is required.

Returns:

this

build

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

Specified by:

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