Class CfnLocationFSxWindows
The AWS::DataSync::LocationFSxWindows
resource specifies an endpoint for an Amazon FSx for Windows Server file system.
Inherited Members
Namespace: Amazon.CDK.AWS.DataSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnLocationFSxWindows : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnLocationFSxWindows
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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(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 |
CfnLocationFSxWindows(Construct, String, ICfnLocationFSxWindowsProps) |
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 Microsoft Active Directory domain that the FSx for Windows File Server file system 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 with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server 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 | Tag Manager which manages the tags for this resource. |
TagsRaw | 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(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
CfnLocationFSxWindows(Construct, String, ICfnLocationFSxWindowsProps)
public CfnLocationFSxWindows(Construct scope, string id, ICfnLocationFSxWindowsProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnLocationFSxWindowsProps
Resource properties.
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 Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.
public virtual string Domain { get; set; }
Property Value
System.String
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
Password
Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.
public virtual string Password { get; set; }
Property Value
System.String
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[]
Subdirectory
Specifies a mount path for your file system using forward slashes.
public virtual string Subdirectory { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Specifies labels that help you categorize, filter, and search for your AWS resources.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
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
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>