CfnLocationFSxWindowsProps

class aws_cdk.aws_datasync.CfnLocationFSxWindowsProps(*, security_group_arns, user, domain=None, fsx_filesystem_arn=None, password=None, subdirectory=None, tags=None)

Bases: object

Properties for defining a CfnLocationFSxWindows.

Parameters:

security_group_arns (Sequence[str]) – The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Windows File Server file system. 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.
user (str) – The user who has the permissions to access files and folders in the FSx for Windows File Server file system. For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user .
domain (Optional[str]) – Specifies the name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to. If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.
fsx_filesystem_arn (Optional[str]) – Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
password (Optional[str]) – 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.
subdirectory (Optional[str]) – Specifies a mount path for your file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination location).
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Specifies labels that help you categorize, filter, and search for your AWS resources. 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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datasync as datasync

cfn_location_fSx_windows_props = datasync.CfnLocationFSxWindowsProps(
    security_group_arns=["securityGroupArns"],
    user="user",

    # the properties below are optional
    domain="domain",
    fsx_filesystem_arn="fsxFilesystemArn",
    password="password",
    subdirectory="subdirectory",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

domain

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

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

fsx_filesystem_arn

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

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.

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

security_group_arns

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

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.

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.

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.

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