Interface CfnLocationFSxONTAPPropsMixin.SMBProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnLocationFSxONTAPPropsMixin.SMBProperty.Jsii$Proxy
- Enclosing class:
CfnLocationFSxONTAPPropsMixin
@Stability(Stable)
public static interface CfnLocationFSxONTAPPropsMixin.SMBProperty
extends software.amazon.jsii.JsiiSerializable
Specifies the Server Message Block (SMB) protocol configuration that AWS DataSync uses to access a storage virtual machine (SVM) on your Amazon FSx for NetApp ONTAP file system.
For more information, see Accessing FSx for ONTAP file systems .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.cfnpropertymixins.services.datasync.*;
SMBProperty sMBProperty = SMBProperty.builder()
.cmkSecretConfig(CmkSecretConfigProperty.builder()
.kmsKeyArn("kmsKeyArn")
.secretArn("secretArn")
.build())
.customSecretConfig(CustomSecretConfigProperty.builder()
.secretAccessRoleArn("secretAccessRoleArn")
.secretArn("secretArn")
.build())
.domain("domain")
.managedSecretConfig(ManagedSecretConfigProperty.builder()
.secretArn("secretArn")
.build())
.mountOptions(SmbMountOptionsProperty.builder()
.version("version")
.build())
.password("password")
.user("user")
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnLocationFSxONTAPPropsMixin.SMBPropertystatic final classAn implementation forCfnLocationFSxONTAPPropsMixin.SMBProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectSpecifies 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.default ObjectSpecifies 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.default StringSpecifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.default ObjectSpecifies 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.default ObjectSpecifies how DataSync can access a location using the SMB protocol.default StringSpecifies the password of a user who has permission to access your SVM.default StringgetUser()Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getCmkSecretConfig
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 union: either
IResolvableorCfnLocationFSxONTAPPropsMixin.CmkSecretConfigProperty- See Also:
-
getCustomSecretConfig
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 union: either
IResolvableorCfnLocationFSxONTAPPropsMixin.CustomSecretConfigProperty- See Also:
-
getDomain
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.
- See Also:
-
getManagedSecretConfig
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 union: either
IResolvableorCfnLocationFSxONTAPPropsMixin.ManagedSecretConfigProperty- See Also:
-
getMountOptions
Specifies how DataSync can access a location using the SMB protocol.Returns union: either
IResolvableorCfnLocationFSxONTAPPropsMixin.SmbMountOptionsProperty- See Also:
-
getPassword
Specifies the password of a user who has permission to access your SVM.- See Also:
-
getUser
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 .
- See Also:
-
builder
-