Package software.amazon.awscdk.cfnpropertymixins.services.datasync

Class CfnLocationFSxWindowsPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.datasync.CfnLocationFSxWindowsPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLocationFSxWindowsPropsMixin>

Enclosing class:

CfnLocationFSxWindowsPropsMixin

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

A fluent builder for CfnLocationFSxWindowsPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnLocationFSxWindowsPropsMixin	build()
CfnLocationFSxWindowsPropsMixin.Builder	cmkSecretConfig(CfnLocationFSxWindowsPropsMixin.CmkSecretConfigProperty cmkSecretConfig)	Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.
CfnLocationFSxWindowsPropsMixin.Builder	cmkSecretConfig(IResolvable cmkSecretConfig)	Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.
static CfnLocationFSxWindowsPropsMixin.Builder	create()
static CfnLocationFSxWindowsPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnLocationFSxWindowsPropsMixin.Builder	customSecretConfig(CfnLocationFSxWindowsPropsMixin.CustomSecretConfigProperty customSecretConfig)	Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.
CfnLocationFSxWindowsPropsMixin.Builder	customSecretConfig(IResolvable customSecretConfig)	Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.
CfnLocationFSxWindowsPropsMixin.Builder	domain(String domain)	Specifies the name of the Windows domain that the FSx for Windows File Server file system belongs to.
CfnLocationFSxWindowsPropsMixin.Builder	fsxFilesystemArn(String fsxFilesystemArn)	Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
CfnLocationFSxWindowsPropsMixin.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.
CfnLocationFSxWindowsPropsMixin.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.
CfnLocationFSxWindowsPropsMixin.Builder	subdirectory(String subdirectory)	Specifies a mount path for your file system using forward slashes.
CfnLocationFSxWindowsPropsMixin.Builder	tags(List<? extends CfnTag> tags)	Specifies labels that help you categorize, filter, and search for your AWS resources.
CfnLocationFSxWindowsPropsMixin.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 CfnLocationFSxWindowsPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnLocationFSxWindowsPropsMixin.Builder.

create

@Stability(Stable)
public static CfnLocationFSxWindowsPropsMixin.Builder create()

Returns:

a new instance of CfnLocationFSxWindowsPropsMixin.Builder.

cmkSecretConfig

@Stability(Stable)
public CfnLocationFSxWindowsPropsMixin.Builder cmkSecretConfig(IResolvable cmkSecretConfig)

Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.

Parameters:

cmkSecretConfig - Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key. This parameter is required.

Returns:

this

See Also:

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

cmkSecretConfig

@Stability(Stable)
public CfnLocationFSxWindowsPropsMixin.Builder cmkSecretConfig(CfnLocationFSxWindowsPropsMixin.CmkSecretConfigProperty cmkSecretConfig)

Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.

Parameters:

cmkSecretConfig - Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key. This parameter is required.

Returns:

this

See Also:

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

customSecretConfig

@Stability(Stable)
public CfnLocationFSxWindowsPropsMixin.Builder customSecretConfig(IResolvable customSecretConfig)

Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.

Parameters:

customSecretConfig - Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret. This parameter is required.

Returns:

this

See Also:

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

customSecretConfig

@Stability(Stable)
public CfnLocationFSxWindowsPropsMixin.Builder customSecretConfig(CfnLocationFSxWindowsPropsMixin.CustomSecretConfigProperty customSecretConfig)

Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.

Parameters:

customSecretConfig - Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret. This parameter is required.

Returns:

this

See Also:

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

domain

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

Specifies the name of the Windows 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 Windows 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 CfnLocationFSxWindowsPropsMixin.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 CfnLocationFSxWindowsPropsMixin.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

securityGroupArns

@Stability(Stable)
public CfnLocationFSxWindowsPropsMixin.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

subdirectory

@Stability(Stable)
public CfnLocationFSxWindowsPropsMixin.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 CfnLocationFSxWindowsPropsMixin.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

user

@Stability(Stable)
public CfnLocationFSxWindowsPropsMixin.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

build

@Stability(Stable)
public CfnLocationFSxWindowsPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnLocationFSxWindowsPropsMixin.