Package software.amazon.awscdk.services.datasync

Interface CfnLocationFSxONTAP.SMBProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLocationFSxONTAP.SMBProperty.Jsii$Proxy

Enclosing class:

CfnLocationFSxONTAP

@Stability(Stable)
public static interface CfnLocationFSxONTAP.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.services.datasync.*;
 SMBProperty sMBProperty = SMBProperty.builder()
         .mountOptions(SmbMountOptionsProperty.builder()
                 .version("version")
                 .build())
         .user("user")
         // the properties below are optional
         .cmkSecretConfig(CmkSecretConfigProperty.builder()
                 .kmsKeyArn("kmsKeyArn")
                 .secretArn("secretArn")
                 .build())
         .customSecretConfig(CustomSecretConfigProperty.builder()
                 .secretAccessRoleArn("secretAccessRoleArn")
                 .secretArn("secretArn")
                 .build())
         .domain("domain")
         .managedSecretConfig(ManagedSecretConfigProperty.builder()
                 .secretArn("secretArn")
                 .build())
         .password("password")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnLocationFSxONTAP.SMBProperty.Builder	A builder for CfnLocationFSxONTAP.SMBProperty
static final class	CfnLocationFSxONTAP.SMBProperty.Jsii$Proxy	An implementation for CfnLocationFSxONTAP.SMBProperty

Method Summary

Modifier and Type	Method	Description
static CfnLocationFSxONTAP.SMBProperty.Builder	builder()
default Object	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.
default Object	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.
default String	getDomain()	Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.
default Object	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.
Object	getMountOptions()	Specifies how DataSync can access a location using the SMB protocol.
default String	getPassword()	Specifies the password of a user who has permission to access your SVM.
String	getUser()	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

getMountOptions

@Stability(Stable)
@NotNull
Object getMountOptions()

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

Returns union: either IResolvable or CfnLocationFSxONTAP.SmbMountOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html#cfn-datasync-locationfsxontap-smb-mountoptions

getUser

@Stability(Stable)
@NotNull
String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html#cfn-datasync-locationfsxontap-smb-user

getCmkSecretConfig

@Stability(Stable)
@Nullable
default Object 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 IResolvable or CfnLocationFSxONTAP.CmkSecretConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html#cfn-datasync-locationfsxontap-smb-cmksecretconfig

getCustomSecretConfig

@Stability(Stable)
@Nullable
default Object 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 IResolvable or CfnLocationFSxONTAP.CustomSecretConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html#cfn-datasync-locationfsxontap-smb-customsecretconfig

getDomain

@Stability(Stable)
@Nullable
default String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html#cfn-datasync-locationfsxontap-smb-domain

getManagedSecretConfig

@Stability(Stable)
@Nullable
default Object 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 IResolvable or CfnLocationFSxONTAP.ManagedSecretConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html#cfn-datasync-locationfsxontap-smb-managedsecretconfig

getPassword

@Stability(Stable)
@Nullable
default String getPassword()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html#cfn-datasync-locationfsxontap-smb-password

builder

@Stability(Stable)
static CfnLocationFSxONTAP.SMBProperty.Builder builder()

Returns:

a CfnLocationFSxONTAP.SMBProperty.Builder of CfnLocationFSxONTAP.SMBProperty