Class CfnLocationFSxWindows
A CloudFormation AWS::DataSync::LocationFSxWindows
.
Inherited Members
Namespace: Amazon.CDK.AWS.DataSync
Assembly: Amazon.CDK.AWS.DataSync.dll
Syntax (csharp)
public class CfnLocationFSxWindows : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnLocationFSxWindows
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::DataSync::LocationFSxWindows
resource specifies an endpoint for an Amazon FSx for Windows Server file system.
CloudformationResource: AWS::DataSync::LocationFSxWindows
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 cfnLocationFSxWindows = new CfnLocationFSxWindows(this, "MyCfnLocationFSxWindows", new CfnLocationFSxWindowsProps {
SecurityGroupArns = new [] { "securityGroupArns" },
User = "user",
// the properties below are optional
Domain = "domain",
FsxFilesystemArn = "fsxFilesystemArn",
Password = "password",
Subdirectory = "subdirectory",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnLocationFSxWindows(Construct, String, ICfnLocationFSxWindowsProps) | Create a new |
CfnLocationFSxWindows(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnLocationFSxWindows(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrLocationArn | The ARN of the specified FSx for Windows Server file system location. |
AttrLocationUri | The URI of the specified FSx for Windows Server file system location. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Domain | Specifies the name of the Windows domain that the FSx for Windows File Server belongs to. |
FsxFilesystemArn | Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system. |
Password | Specifies the password of the user who has the permissions to access files and folders in the file system. |
SecurityGroupArns | The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Windows File Server file system. |
Subdirectory | Specifies a mount path for your file system using forward slashes. |
Tags | Specifies labels that help you categorize, filter, and search for your AWS resources. |
User | The user who has the permissions to access files and folders in the FSx for Windows File Server file system. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnLocationFSxWindows(Construct, String, ICfnLocationFSxWindowsProps)
Create a new AWS::DataSync::LocationFSxWindows
.
public CfnLocationFSxWindows(Construct scope, string id, ICfnLocationFSxWindowsProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnLocationFSxWindowsProps
- resource properties.
CfnLocationFSxWindows(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnLocationFSxWindows(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnLocationFSxWindows(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnLocationFSxWindows(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrLocationArn
The ARN of the specified FSx for Windows Server file system location.
public virtual string AttrLocationArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LocationArn
AttrLocationUri
The URI of the specified FSx for Windows Server file system 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 name of the Windows domain that the FSx for Windows File Server belongs to.
public virtual string Domain { get; set; }
Property Value
System.String
Remarks
FsxFilesystemArn
Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
public virtual string FsxFilesystemArn { get; set; }
Property Value
System.String
Remarks
Password
Specifies the password of the user who has the permissions to access files and folders in the file system.
public virtual string Password { get; set; }
Property Value
System.String
Remarks
SecurityGroupArns
The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Windows File Server file system.
public virtual string[] SecurityGroupArns { get; set; }
Property Value
System.String[]
Remarks
Pattern : ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z-0-9]:[0-9]{12}:security-group/.$
Length constraints : Maximum length of 128.
Subdirectory
Specifies a mount path for your file system using forward slashes.
public virtual string Subdirectory { get; set; }
Property Value
System.String
Remarks
This is where DataSync reads or writes data (depending on if this is a source or destination location).
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 has the permissions to access files and folders in the FSx for Windows File Server file system.
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>