Package software.amazon.awscdk.services.datasync

Class CfnLocationFSxWindows.Builder

java.lang.Object

software.amazon.awscdk.services.datasync.CfnLocationFSxWindows.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLocationFSxWindows>

Enclosing class:

CfnLocationFSxWindows

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

A fluent builder for CfnLocationFSxWindows.

Method Summary

Modifier and Type	Method	Description
CfnLocationFSxWindows	build()
static CfnLocationFSxWindows.Builder	create(software.constructs.Construct scope, String id)
CfnLocationFSxWindows.Builder	domain(String domain)	Specifies the name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.
CfnLocationFSxWindows.Builder	fsxFilesystemArn(String fsxFilesystemArn)	Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
CfnLocationFSxWindows.Builder	password(String password)	Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.
CfnLocationFSxWindows.Builder	securityGroupArns(List<String> securityGroupArns)	The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Windows File Server file system.
CfnLocationFSxWindows.Builder	subdirectory(String subdirectory)	Specifies a mount path for your file system using forward slashes.
CfnLocationFSxWindows.Builder	tags(List<? extends CfnTag> tags)	Specifies labels that help you categorize, filter, and search for your AWS resources.
CfnLocationFSxWindows.Builder	user(String user)	The user who has the permissions to access files and folders in the FSx for Windows File Server file system.

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 CfnLocationFSxWindows.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 CfnLocationFSxWindows.Builder.

securityGroupArns

@Stability(Stable)
public CfnLocationFSxWindows.Builder securityGroupArns(List<String> securityGroupArns)

The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Windows File Server file system.

Pattern : ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/.*$

Length constraints : Maximum length of 128.

Parameters:

securityGroupArns - The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Windows File Server file system. This parameter is required.

Returns:

this

See Also:

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

user

@Stability(Stable)
public CfnLocationFSxWindows.Builder user(String user)

The user who has the permissions to access files and folders in the FSx for Windows File Server file system.

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

Parameters:

user - The user who has the permissions to access files and folders in the FSx for Windows File Server file system. This parameter is required.

Returns:

this

See Also:

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

domain

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

Specifies the name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.

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

Parameters:

domain - Specifies the name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to. This parameter is required.

Returns:

this

See Also:

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

fsxFilesystemArn

@Stability(Stable)
public CfnLocationFSxWindows.Builder fsxFilesystemArn(String fsxFilesystemArn)

Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.

Parameters:

fsxFilesystemArn - Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system. This parameter is required.

Returns:

this

See Also:

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

password

@Stability(Stable)
public CfnLocationFSxWindows.Builder password(String password)

Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.

Parameters:

password - Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system. This parameter is required.

Returns:

this

See Also:

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

subdirectory

@Stability(Stable)
public CfnLocationFSxWindows.Builder subdirectory(String subdirectory)

Specifies a mount path for your file system using forward slashes.

This is where DataSync reads or writes data (depending on if this is a source or destination location).

Parameters:

subdirectory - Specifies a mount path for your file system using forward slashes. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnLocationFSxWindows.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-locationfsxwindows.html#cfn-datasync-locationfsxwindows-tags

build

@Stability(Stable)
public CfnLocationFSxWindows build()

Specified by:

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

Returns:

a newly built instance of CfnLocationFSxWindows.