Class CfnLocationSMB
A CloudFormation AWS::DataSync::LocationSMB
.
Inherited Members
Namespace: Amazon.CDK.AWS.DataSync
Assembly: Amazon.CDK.AWS.DataSync.dll
Syntax (csharp)
public class CfnLocationSMB : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnLocationSMB
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::DataSync::LocationSMB
resource specifies a Server Message Block (SMB) location.
CloudformationResource: AWS::DataSync::LocationSMB
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;
var cfnLocationSMB = new CfnLocationSMB(this, "MyCfnLocationSMB", new CfnLocationSMBProps {
AgentArns = new [] { "agentArns" },
User = "user",
// the properties below are optional
Domain = "domain",
MountOptions = new MountOptionsProperty {
Version = "version"
},
Password = "password",
ServerHostname = "serverHostname",
Subdirectory = "subdirectory",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnLocationSMB(Construct, String, ICfnLocationSMBProps) | Create a new |
CfnLocationSMB(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnLocationSMB(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AgentArns | The Amazon Resource Names (ARNs) of agents to use for a Server Message Block (SMB) location. |
AttrLocationArn | The Amazon Resource Name (ARN) of the specified SMB file system. |
AttrLocationUri | The URI of the specified SMB location. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Domain | Specifies the Windows domain name that your SMB file server belongs to. |
MountOptions | Specifies the version of the SMB protocol that DataSync uses to access your SMB file 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 | Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount. |
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 | Specifies labels that help you categorize, filter, and search for your AWS resources. |
User | The user who can mount the share and has the permissions to access files and folders in the SMB share. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnLocationSMB(Construct, String, ICfnLocationSMBProps)
Create a new AWS::DataSync::LocationSMB
.
public CfnLocationSMB(Construct scope, string id, ICfnLocationSMBProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnLocationSMBProps
- resource properties.
CfnLocationSMB(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnLocationSMB(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnLocationSMB(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnLocationSMB(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AgentArns
The Amazon Resource Names (ARNs) of agents to use for a Server Message Block (SMB) location.
public virtual string[] AgentArns { get; set; }
Property Value
System.String[]
Remarks
AttrLocationArn
The Amazon Resource Name (ARN) of the specified SMB file system.
public virtual string AttrLocationArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LocationArn
AttrLocationUri
The URI of the specified SMB location.
public virtual string AttrLocationUri { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LocationUri
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Domain
Specifies the Windows domain name that your SMB file server belongs to.
public virtual string Domain { get; set; }
Property Value
System.String
Remarks
For more information, see required permissions for SMB locations.
MountOptions
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
public virtual object MountOptions { get; set; }
Property Value
System.Object
Remarks
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 virtual string Password { get; set; }
Property Value
System.String
Remarks
ServerHostname
Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.
public virtual string ServerHostname { get; set; }
Property Value
System.String
Remarks
You can't specify an IP version 6 (IPv6) address.
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 virtual 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.
Tags
Specifies labels that help you categorize, filter, and search for your AWS resources.
public virtual TagManager Tags { get; }
Property Value
Remarks
We recommend creating at least a name tag for your location.
User
The user who can mount the share and has the permissions to access files and folders in the SMB share.
public virtual 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 .
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>