Show / Hide Table of Contents

Class CfnLocationFSxWindowsProps

Properties for defining a CfnLocationFSxWindows.

Inheritance
object
CfnLocationFSxWindowsProps
Implements
ICfnLocationFSxWindowsProps
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 CfnLocationFSxWindowsProps : ICfnLocationFSxWindowsProps
Syntax (vb)
Public Class CfnLocationFSxWindowsProps Implements ICfnLocationFSxWindowsProps
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.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 cfnLocationFSxWindowsProps = 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

CfnLocationFSxWindowsProps()

Properties for defining a CfnLocationFSxWindows.

Properties

Domain

Specifies the name of the Windows 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

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.

Constructors

CfnLocationFSxWindowsProps()

Properties for defining a CfnLocationFSxWindows.

public CfnLocationFSxWindowsProps()
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.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 cfnLocationFSxWindowsProps = 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"
                 } }
             };

Properties

Domain

Specifies the name of the Windows domain that the FSx for Windows File Server file system belongs to.

public string? Domain { get; set; }
Property Value

string

Remarks

If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.

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

FsxFilesystemArn

Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.

public string? FsxFilesystemArn { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html#cfn-datasync-locationfsxwindows-fsxfilesystemarn

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 string? Password { get; set; }
Property Value

string

Remarks

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

SecurityGroupArns

The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Windows File Server file system.

public string[] SecurityGroupArns { get; set; }
Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html#cfn-datasync-locationfsxwindows-securitygrouparns

Subdirectory

Specifies a mount path for your file system using forward slashes.

public string? Subdirectory { get; set; }
Property Value

string

Remarks

This is where DataSync reads or writes data (depending on if this is a source or destination location).

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

Tags

Specifies labels that help you categorize, filter, and search for your AWS resources.

public ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

Remarks

We recommend creating at least a name tag for your location.

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

User

The user who has the permissions to access files and folders in the FSx for Windows File Server file system.

public string User { get; set; }
Property Value

string

Remarks

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

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

Implements

ICfnLocationFSxWindowsProps
Back to top Generated by DocFX