Class CfnLocationFSxONTAP.SMBProperty.Builder
java.lang.Object
software.amazon.awscdk.services.datasync.CfnLocationFSxONTAP.SMBProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnLocationFSxONTAP.SMBProperty>
- Enclosing interface:
CfnLocationFSxONTAP.SMBProperty
@Stability(Stable)
public static final class CfnLocationFSxONTAP.SMBProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnLocationFSxONTAP.SMBProperty>
A builder for
CfnLocationFSxONTAP.SMBProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.cmkSecretConfig(IResolvable cmkSecretConfig) Sets the value ofCfnLocationFSxONTAP.SMBProperty.getCmkSecretConfig()cmkSecretConfig(CfnLocationFSxONTAP.CmkSecretConfigProperty cmkSecretConfig) Sets the value ofCfnLocationFSxONTAP.SMBProperty.getCmkSecretConfig()customSecretConfig(IResolvable customSecretConfig) Sets the value ofCfnLocationFSxONTAP.SMBProperty.getCustomSecretConfig()customSecretConfig(CfnLocationFSxONTAP.CustomSecretConfigProperty customSecretConfig) Sets the value ofCfnLocationFSxONTAP.SMBProperty.getCustomSecretConfig()Sets the value ofCfnLocationFSxONTAP.SMBProperty.getDomain()managedSecretConfig(IResolvable managedSecretConfig) Sets the value ofCfnLocationFSxONTAP.SMBProperty.getManagedSecretConfig()managedSecretConfig(CfnLocationFSxONTAP.ManagedSecretConfigProperty managedSecretConfig) Sets the value ofCfnLocationFSxONTAP.SMBProperty.getManagedSecretConfig()mountOptions(IResolvable mountOptions) Sets the value ofCfnLocationFSxONTAP.SMBProperty.getMountOptions()mountOptions(CfnLocationFSxONTAP.SmbMountOptionsProperty mountOptions) Sets the value ofCfnLocationFSxONTAP.SMBProperty.getMountOptions()Sets the value ofCfnLocationFSxONTAP.SMBProperty.getPassword()Sets the value ofCfnLocationFSxONTAP.SMBProperty.getUser()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
mountOptions
@Stability(Stable) public CfnLocationFSxONTAP.SMBProperty.Builder mountOptions(IResolvable mountOptions) Sets the value ofCfnLocationFSxONTAP.SMBProperty.getMountOptions()- Parameters:
mountOptions- Specifies how DataSync can access a location using the SMB protocol. This parameter is required.- Returns:
this
-
mountOptions
@Stability(Stable) public CfnLocationFSxONTAP.SMBProperty.Builder mountOptions(CfnLocationFSxONTAP.SmbMountOptionsProperty mountOptions) Sets the value ofCfnLocationFSxONTAP.SMBProperty.getMountOptions()- Parameters:
mountOptions- Specifies how DataSync can access a location using the SMB protocol. This parameter is required.- Returns:
this
-
user
Sets the value ofCfnLocationFSxONTAP.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. This parameter is required. 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
-
cmkSecretConfig
@Stability(Stable) public CfnLocationFSxONTAP.SMBProperty.Builder cmkSecretConfig(IResolvable cmkSecretConfig) Sets the value ofCfnLocationFSxONTAP.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 CfnLocationFSxONTAP.SMBProperty.Builder cmkSecretConfig(CfnLocationFSxONTAP.CmkSecretConfigProperty cmkSecretConfig) Sets the value ofCfnLocationFSxONTAP.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 CfnLocationFSxONTAP.SMBProperty.Builder customSecretConfig(IResolvable customSecretConfig) Sets the value ofCfnLocationFSxONTAP.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 CfnLocationFSxONTAP.SMBProperty.Builder customSecretConfig(CfnLocationFSxONTAP.CustomSecretConfigProperty customSecretConfig) Sets the value ofCfnLocationFSxONTAP.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
Sets the value ofCfnLocationFSxONTAP.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 CfnLocationFSxONTAP.SMBProperty.Builder managedSecretConfig(IResolvable managedSecretConfig) Sets the value ofCfnLocationFSxONTAP.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 CfnLocationFSxONTAP.SMBProperty.Builder managedSecretConfig(CfnLocationFSxONTAP.ManagedSecretConfigProperty managedSecretConfig) Sets the value ofCfnLocationFSxONTAP.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
-
password
Sets the value ofCfnLocationFSxONTAP.SMBProperty.getPassword()- Parameters:
password- Specifies the password of a user who has permission to access your SVM.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnLocationFSxONTAP.SMBProperty>- Returns:
- a new instance of
CfnLocationFSxONTAP.SMBProperty - Throws:
NullPointerException- if any required attribute was not provided
-