Package 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(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	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)	Specifies the name of the Active Directory domain that your SMB file server belongs to.
CfnLocationSMB.Builder	mountOptions(IResolvable mountOptions)	Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
CfnLocationSMB.Builder	mountOptions(CfnLocationSMB.MountOptionsProperty mountOptions)	Specifies the version of the SMB protocol that DataSync uses to access your SMB file 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)	Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.
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)	Specifies labels that help you categorize, filter, and search for your AWS resources.
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 Details

create

@Stability(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 - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnLocationSMB.Builder.

agentArns

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

See Also:

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

user

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

See Also:

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

domain

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

Specifies the name of the Active Directory domain that your SMB file server belongs to.

If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

Parameters:

domain - Specifies the name of the Active Directory domain that your SMB file server belongs to. This parameter is required.

Returns:

this

See Also:

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

mountOptions

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

Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

Parameters:

mountOptions - Specifies the version of the SMB protocol that DataSync uses to access your SMB file server. This parameter is required.

Returns:

this

See Also:

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

mountOptions

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

Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

Parameters:

mountOptions - Specifies the version of the SMB protocol that DataSync uses to access your SMB file server. This parameter is required.

Returns:

this

See Also:

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

password

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

See Also:

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

serverHostname

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

Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.

You can't specify an IP version 6 (IPv6) address.

Parameters:

serverHostname - Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount. This parameter is required.

Returns:

this

See Also:

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

subdirectory

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

See Also:

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

tags

@Stability(Stable)
public CfnLocationSMB.Builder tags(List<? extends CfnTag> tags)

Specifies labels that help you categorize, filter, and search for your AWS resources.

We recommend creating at least a name tag for your location.

Parameters:

tags - Specifies labels that help you categorize, filter, and search for your AWS resources. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnLocationSMB build()

Specified by:

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

Returns:

a newly built instance of CfnLocationSMB.