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

Class CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.datasync.CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLocationFSxONTAPPropsMixin.SMBProperty>

Enclosing interface:

CfnLocationFSxONTAPPropsMixin.SMBProperty

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

A builder for CfnLocationFSxONTAPPropsMixin.SMBProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnLocationFSxONTAPPropsMixin.SMBProperty	build()	Builds the configured instance.
CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder	cmkSecretConfig(CfnLocationFSxONTAPPropsMixin.CmkSecretConfigProperty cmkSecretConfig)	Sets the value of CfnLocationFSxONTAPPropsMixin.SMBProperty.getCmkSecretConfig()
CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder	cmkSecretConfig(IResolvable cmkSecretConfig)	Sets the value of CfnLocationFSxONTAPPropsMixin.SMBProperty.getCmkSecretConfig()
CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder	customSecretConfig(CfnLocationFSxONTAPPropsMixin.CustomSecretConfigProperty customSecretConfig)	Sets the value of CfnLocationFSxONTAPPropsMixin.SMBProperty.getCustomSecretConfig()
CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder	customSecretConfig(IResolvable customSecretConfig)	Sets the value of CfnLocationFSxONTAPPropsMixin.SMBProperty.getCustomSecretConfig()
CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder	domain(String domain)	Sets the value of CfnLocationFSxONTAPPropsMixin.SMBProperty.getDomain()
CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder	managedSecretConfig(CfnLocationFSxONTAPPropsMixin.ManagedSecretConfigProperty managedSecretConfig)	Sets the value of CfnLocationFSxONTAPPropsMixin.SMBProperty.getManagedSecretConfig()
CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder	managedSecretConfig(IResolvable managedSecretConfig)	Sets the value of CfnLocationFSxONTAPPropsMixin.SMBProperty.getManagedSecretConfig()
CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder	mountOptions(CfnLocationFSxONTAPPropsMixin.SmbMountOptionsProperty mountOptions)	Sets the value of CfnLocationFSxONTAPPropsMixin.SMBProperty.getMountOptions()
CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder	mountOptions(IResolvable mountOptions)	Sets the value of CfnLocationFSxONTAPPropsMixin.SMBProperty.getMountOptions()
CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder	password(String password)	Sets the value of CfnLocationFSxONTAPPropsMixin.SMBProperty.getPassword()
CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder	user(String user)	Sets the value of CfnLocationFSxONTAPPropsMixin.SMBProperty.getUser()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

cmkSecretConfig

@Stability(Stable)
public CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder cmkSecretConfig(IResolvable cmkSecretConfig)

Sets the value of CfnLocationFSxONTAPPropsMixin.SMBProperty.getCmkSecretConfig()

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.

Returns:

this

cmkSecretConfig

@Stability(Stable)
public CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder cmkSecretConfig(CfnLocationFSxONTAPPropsMixin.CmkSecretConfigProperty cmkSecretConfig)

Sets the value of CfnLocationFSxONTAPPropsMixin.SMBProperty.getCmkSecretConfig()

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.

Returns:

this

customSecretConfig

@Stability(Stable)
public CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder customSecretConfig(IResolvable customSecretConfig)

Sets the value of CfnLocationFSxONTAPPropsMixin.SMBProperty.getCustomSecretConfig()

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.

Returns:

this

customSecretConfig

@Stability(Stable)
public CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder customSecretConfig(CfnLocationFSxONTAPPropsMixin.CustomSecretConfigProperty customSecretConfig)

Sets the value of CfnLocationFSxONTAPPropsMixin.SMBProperty.getCustomSecretConfig()

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.

Returns:

this

domain

@Stability(Stable)
public CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder domain(String domain)

Sets the value of CfnLocationFSxONTAPPropsMixin.SMBProperty.getDomain()

Parameters:

domain - Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to. If you have multiple domains in your environment, configuring this setting makes sure that DataSync connects to the right SVM.

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

Returns:

this

managedSecretConfig

@Stability(Stable)
public CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder managedSecretConfig(IResolvable managedSecretConfig)

Sets the value of CfnLocationFSxONTAPPropsMixin.SMBProperty.getManagedSecretConfig()

Parameters:

managedSecretConfig - 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. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.

Returns:

this

managedSecretConfig

@Stability(Stable)
public CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder managedSecretConfig(CfnLocationFSxONTAPPropsMixin.ManagedSecretConfigProperty managedSecretConfig)

Sets the value of CfnLocationFSxONTAPPropsMixin.SMBProperty.getManagedSecretConfig()

Parameters:

managedSecretConfig - 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. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.

Returns:

this

mountOptions

@Stability(Stable)
public CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder mountOptions(IResolvable mountOptions)

Sets the value of CfnLocationFSxONTAPPropsMixin.SMBProperty.getMountOptions()

Parameters:

mountOptions - Specifies how DataSync can access a location using the SMB protocol.

Returns:

this

mountOptions

@Stability(Stable)
public CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder mountOptions(CfnLocationFSxONTAPPropsMixin.SmbMountOptionsProperty mountOptions)

Sets the value of CfnLocationFSxONTAPPropsMixin.SMBProperty.getMountOptions()

Parameters:

mountOptions - Specifies how DataSync can access a location using the SMB protocol.

Returns:

this

password

@Stability(Stable)
public CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder password(String password)

Sets the value of CfnLocationFSxONTAPPropsMixin.SMBProperty.getPassword()

Parameters:

password - Specifies the password of a user who has permission to access your SVM.

Returns:

this

user

@Stability(Stable)
public CfnLocationFSxONTAPPropsMixin.SMBProperty.Builder user(String user)

Sets the value of CfnLocationFSxONTAPPropsMixin.SMBProperty.getUser()

Parameters:

user - Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM. If you provide a user in your Active Directory, note the following:

• If you're using AWS Directory Service for Microsoft Active Directory , the user must be a member of the AWS Delegated FSx Administrators group.
• If you're using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.

Make sure that the user has the permissions it needs to copy the data you want:

• SE_TCB_NAME : Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).
• SE_SECURITY_NAME : May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options .

Returns:

this

build

@Stability(Stable)
public CfnLocationFSxONTAPPropsMixin.SMBProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnLocationFSxONTAPPropsMixin.SMBProperty>

Returns:

a new instance of CfnLocationFSxONTAPPropsMixin.SMBProperty

Throws:

NullPointerException - if any required attribute was not provided