software.amazon.awscdk.services.datasync

Class CfnLocationSMB.Builder

java.lang.Object

software.amazon.awscdk.services.datasync.CfnLocationSMB.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLocationSMB>

Enclosing class:

CfnLocationSMB

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

A fluent builder for CfnLocationSMB.

Method Summary

Modifier and Type	Method and Description
CfnLocationSMB.Builder	agentArns(List<String> agentArns) The Amazon Resource Names (ARNs) of agents to use for a Server Message Block (SMB) location.
CfnLocationSMB	build()
static CfnLocationSMB.Builder	create(software.constructs.Construct scope, String id)
CfnLocationSMB.Builder	domain(String domain) The name of the Windows domain that the SMB server belongs to.
CfnLocationSMB.Builder	mountOptions(CfnLocationSMB.MountOptionsProperty mountOptions) The mount options used by DataSync to access the SMB server.
CfnLocationSMB.Builder	mountOptions(IResolvable mountOptions) The mount options used by DataSync to access the SMB server.
CfnLocationSMB.Builder	password(String password) The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
CfnLocationSMB.Builder	serverHostname(String serverHostname) The name of the SMB server.
CfnLocationSMB.Builder	subdirectory(String subdirectory) The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination.
CfnLocationSMB.Builder	tags(List<? extends CfnTag> tags) The key-value pair that represents the tag that you want to add to the location.
CfnLocationSMB.Builder	user(String user) The user who can mount the share and has the permissions to access files and folders in the SMB share.

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 CfnLocationSMB.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 CfnLocationSMB.MountOptionsProperty.Builder.

agentArns

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

The Amazon Resource Names (ARNs) of agents to use for a Server Message Block (SMB) location.

Parameters:

agentArns - The Amazon Resource Names (ARNs) of agents to use for a Server Message Block (SMB) location. This parameter is required.

Returns:

this

password

@Stability(value=Stable)
public CfnLocationSMB.Builder password(String password)

The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.

Parameters:

password - The password of the user who can mount the share and has the permissions to access files and folders in the SMB share. This parameter is required.

Returns:

this

serverHostname

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

The name of the SMB server.

This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

Parameters:

serverHostname - The name of the SMB server. This parameter is required.

Returns:

this

subdirectory

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

The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination.

The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder .

To transfer all the data in the folder you specified, DataSync must have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either make sure that the user name and password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either one enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

Parameters:

subdirectory - The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. This parameter is required.

Returns:

this

user

@Stability(value=Stable)
public CfnLocationSMB.Builder user(String user)

The user who can mount the share and has the permissions to access files and folders in the SMB share.

For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user .

Parameters:

user - The user who can mount the share and has the permissions to access files and folders in the SMB share. This parameter is required.

Returns:

this

domain

@Stability(value=Stable)
public CfnLocationSMB.Builder domain(String domain)

The name of the Windows domain that the SMB server belongs to.

Parameters:

domain - The name of the Windows domain that the SMB server belongs to. This parameter is required.

Returns:

this

mountOptions

@Stability(value=Stable)
public CfnLocationSMB.Builder mountOptions(CfnLocationSMB.MountOptionsProperty mountOptions)

The mount options used by DataSync to access the SMB server.

Parameters:

mountOptions - The mount options used by DataSync to access the SMB server. This parameter is required.

Returns:

this

mountOptions

@Stability(value=Stable)
public CfnLocationSMB.Builder mountOptions(IResolvable mountOptions)

The mount options used by DataSync to access the SMB server.

Parameters:

mountOptions - The mount options used by DataSync to access the SMB server. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnLocationSMB.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 CfnLocationSMB build()

Specified by:

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