Class CfnLocationFSxONTAP.SMBProperty

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.

Inheritance

object

CfnLocationFSxONTAP.SMBProperty

Implements

CfnLocationFSxONTAP.ISMBProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.DataSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnLocationFSxONTAP.SMBProperty : CfnLocationFSxONTAP.ISMBProperty

Syntax (vb)

Public Class CfnLocationFSxONTAP.SMBProperty Implements CfnLocationFSxONTAP.ISMBProperty

Remarks

For more information, see Accessing FSx for ONTAP file systems .

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.DataSync;

             var sMBProperty = new SMBProperty {
                 MountOptions = new SmbMountOptionsProperty {
                     Version = "version"
                 },
                 User = "user",

                 // the properties below are optional
                 CmkSecretConfig = new CmkSecretConfigProperty {
                     KmsKeyArn = "kmsKeyArn",
                     SecretArn = "secretArn"
                 },
                 CustomSecretConfig = new CustomSecretConfigProperty {
                     SecretAccessRoleArn = "secretAccessRoleArn",
                     SecretArn = "secretArn"
                 },
                 Domain = "domain",
                 ManagedSecretConfig = new ManagedSecretConfigProperty {
                     SecretArn = "secretArn"
                 },
                 Password = "password"
             };

Synopsis

Constructors

SMBProperty()

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.

Properties

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.
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.
Domain	Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.
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.
MountOptions	Specifies how DataSync can access a location using the SMB protocol.
Password	Specifies the password of a user who has permission to access your SVM.
User	Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.

Constructors

SMBProperty()

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.

public SMBProperty()

Remarks

For more information, see Accessing FSx for ONTAP file systems .

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.DataSync;

             var sMBProperty = new SMBProperty {
                 MountOptions = new SmbMountOptionsProperty {
                     Version = "version"
                 },
                 User = "user",

                 // the properties below are optional
                 CmkSecretConfig = new CmkSecretConfigProperty {
                     KmsKeyArn = "kmsKeyArn",
                     SecretArn = "secretArn"
                 },
                 CustomSecretConfig = new CustomSecretConfigProperty {
                     SecretAccessRoleArn = "secretAccessRoleArn",
                     SecretArn = "secretArn"
                 },
                 Domain = "domain",
                 ManagedSecretConfig = new ManagedSecretConfigProperty {
                     SecretArn = "secretArn"
                 },
                 Password = "password"
             };

Properties

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.

public object? CmkSecretConfig { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnLocationFSxONTAP.ICmkSecretConfigProperty

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.

public object? CustomSecretConfig { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnLocationFSxONTAP.ICustomSecretConfigProperty

Domain

Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.

public string? Domain { get; set; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html#cfn-datasync-locationfsxontap-smb-domain

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.

public object? ManagedSecretConfig { get; set; }

Property Value

object

Remarks

DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.

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

Type union: either IResolvable or CfnLocationFSxONTAP.IManagedSecretConfigProperty

MountOptions

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

public object MountOptions { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnLocationFSxONTAP.ISmbMountOptionsProperty

Password

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

public string? Password { get; set; }

Property Value

string

Remarks

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

User

Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.

public string User { get; set; }

Property Value

string

Remarks

If you provide a user in your Active Directory, note the following:

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

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

Implements

CfnLocationFSxONTAP.ISMBProperty