Class CfnLocationSMBProps

Properties for defining a CfnLocationSMB.

Inheritance

System.Object

CfnLocationSMBProps

Implements

ICfnLocationSMBProps

Namespace: Amazon.CDK.AWS.DataSync

Assembly: Amazon.CDK.AWS.DataSync.dll

Syntax (csharp)

public class CfnLocationSMBProps : Object, ICfnLocationSMBProps

Syntax (vb)

Public Class CfnLocationSMBProps
    Inherits Object
    Implements ICfnLocationSMBProps

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.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;

CfnLocationSMBProps cfnLocationSMBProps = new CfnLocationSMBProps {
    AgentArns = new [] { "agentArns" },
    Password = "password",
    ServerHostname = "serverHostname",
    Subdirectory = "subdirectory",
    User = "user",

    // the properties below are optional
    Domain = "domain",
    MountOptions = new MountOptionsProperty {
        Version = "version"
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};

Synopsis

Constructors

CfnLocationSMBProps()

Properties

AgentArns	The Amazon Resource Names (ARNs) of agents to use for a Server Message Block (SMB) location.
Domain	The name of the Windows domain that the SMB server belongs to.
MountOptions	The mount options used by DataSync to access the SMB server.
Password	The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
ServerHostname	The name of the SMB server.
Subdirectory	The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination.
Tags	The key-value pair that represents the tag that you want to add to the location.
User	The user who can mount the share and has the permissions to access files and folders in the SMB share.

Constructors

CfnLocationSMBProps()

public CfnLocationSMBProps()

Properties

AgentArns

The Amazon Resource Names (ARNs) of agents to use for a Server Message Block (SMB) location.

public string[] AgentArns { get; set; }

Property Value

System.String[]

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-agentarns

Domain

The name of the Windows domain that the SMB server belongs to.

public string Domain { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-domain

MountOptions

The mount options used by DataSync to access the SMB server.

public object MountOptions { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-mountoptions

Password

The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.

public string Password { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-password

ServerHostname

The name of the SMB server.

public string ServerHostname { get; set; }

Property Value

System.String

Remarks

This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-serverhostname

Subdirectory

The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination.

public string Subdirectory { get; set; }

Property Value

System.String

Remarks

The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder .

To transfer all the data in the folder you specified, DataSync must have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either make sure that the user name and password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either one enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-subdirectory

Tags

The key-value pair that represents the tag that you want to add to the location.

public ICfnTag[] Tags { get; set; }

Property Value

ICfnTag[]

Remarks

The value can be an empty string. We recommend using tags to name your resources.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-tags

User

The user who can mount the share and has the permissions to access files and folders in the SMB share.

public string User { get; set; }

Property Value

System.String

Remarks

For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-user

Implements

ICfnLocationSMBProps