AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::DataSync::LocationFSxWindows

CfnLocationFSxWindows

The `AWS::DataSync::LocationFSxWindows` resource specifies an endpoint for an Amazon FSx for Windows Server file system.

Import

import { CfnLocationFSxWindows } from 'aws-cdk-lib/aws-datasync';

Or use the module namespace:

import * as datasync from 'aws-cdk-lib/aws-datasync';
// datasync.CfnLocationFSxWindows

Properties

Configuration passed to the constructor as CfnLocationFSxWindowsProps.

securityGroupArnsRequired
string[]

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.

userRequired
string

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](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#FSxWuser) .

cmkSecretConfigOptional
IResolvable | CmkSecretConfigProperty

Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.

customSecretConfigOptional
IResolvable | CustomSecretConfigProperty

Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.

domainOptional
string

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

fsxFilesystemArnOptional
string

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

passwordOptional
string

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.

subdirectoryOptional
string

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).

tagsOptional
CfnTag[]

Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least a name tag for your location.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter