AWS::DataSync::LocationFSxWindows
The AWS::DataSync::LocationFSxWindows
resource specifies an endpoint for an Amazon FSx for Windows file system.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::DataSync::LocationFSxWindows", "Properties" : { "Domain" :
String
, "FsxFilesystemArn" :String
, "Password" :String
, "SecurityGroupArns" :[ String, ... ]
, "Subdirectory" :String
, "Tags" :[ Tag, ... ]
, "User" :String
} }
YAML
Type: AWS::DataSync::LocationFSxWindows Properties: Domain:
String
FsxFilesystemArn:String
Password:String
SecurityGroupArns:- String
Subdirectory:String
Tags:- Tag
User:String
Properties
Domain
-
The name of the Windows domain that the FSx for Windows File Server belongs to.
Required: No
Type: String
Maximum:
253
Pattern:
^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$
Update requires: Replacement
FsxFilesystemArn
-
The Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
Required: Yes
Type: String
Maximum:
128
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\-0-9]*:[0-9]{12}:file-system/fs-.*$
Update requires: Replacement
Password
-
The password of the user who has the permissions to access files and folders in the FSx for Windows File Server file system.
Required: Yes
Type: String
Maximum:
104
Pattern:
^.{0,104}$
Update requires: Replacement
SecurityGroupArns
-
The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Windows File Server file system.
Required: Yes
Type: List of String
Maximum:
5
Update requires: Replacement
Subdirectory
-
A subdirectory in the location’s path. This subdirectory in the Amazon FSx for Windows File Server file system is used to read data from the Amazon FSx for Windows File Server source location or write data to the FSx for Windows File Server destination.
Required: No
Type: String
Maximum:
4096
Pattern:
^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$
Update requires: Replacement
Tags
-
The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.
Required: No
Type: List of Tag
Maximum:
50
Update requires: No interruption
User
-
The user who has the permissions to access files and folders in the FSx for Windows File Server file system.
Required: Yes
Type: String
Maximum:
104
Pattern:
^[^\x5B\x5D\\/:;|=,+*?]{1,104}$
Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the location resource ARN. For example:
arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3
For more information about using the Ref
function, see Ref.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute
of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function,
see Fn::GetAtt.
Examples
Create an Amazon FSxWindows location for DataSync
The following example specifies an FSxWindows location to be used by
DataSync, with the subdirectory /MySubdirectory
, user
Admin
and password.
JSON
{ "AWSTemplateFormatVersion": "2010-09-09", "Description": "Specifies an FSxWindows location for DataSync", "Resources": { "LocationFSxWindows": { "Type": "AWS::DataSync::LocationFSxWindows", "Properties": { "FsxFilesystemArn": "arn:aws:fsx:us-east-2:111222333444:file-system/fs-12345fsx", "SecurityGroupArns": [ "arn:aws:ec2:us-east-2:11122233344:security-group/sg-0117195988293d62f" ], "Subdirectory": "/MySubdirectory", "User": "Admin", "Password": {"Ref": "Password"}, } } }
YAML
AWSTemplateFormatVersion: 2010-09-09 Description: Specifies an FSxWindows location for DataSync Resources: LocationFSxWindows: Type: AWS::DataSync::LocationFSxWindows Properties: FsxFilesystemArn: arn:aws:fsx:us-east-2:111222333444:file-system/fs-12345fsx SecurityGroupArns: - arn:aws:ec2:us-east-2:11122233344:security-group/sg-0117195988293d62f Subdirectory: /MySubdirectory User: Admin Password: !Ref Password