AWS::DataSync::LocationFSxWindows

The AWS::DataSync::LocationFSxWindows resource specifies an endpoint for an Amazon FSx for Windows Server 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

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

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

For more information, see required permissions for FSx for Windows File Server locations.

Required: No

Type: String

Maximum: 253

Pattern: ^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$

Update requires: Replacement

FsxFilesystemArn

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

Required: No

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

Specifies the password of the user who has the permissions to access files and folders in the file system.

For more information, see required permissions for FSx for Windows File Server locations.

Required: No

Type: String

Maximum: 104

Pattern: ^.{0,104}$

Update requires: Replacement

SecurityGroupArns

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.

Required: Yes

Type: List of String

Update requires: Replacement

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

Required: No

Type: String

Maximum: 4096

Pattern: ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$

Update requires: Replacement

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.

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.

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

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.

LocationArn

The ARN of the specified FSx for Windows Server file system location.

LocationUri

The URI of the specified FSx for Windows Server file system location.

Examples

Specify an Amazon FSx for Windows File Server location for DataSync

The following examples specify an FSx for Windows File Server location for DataSync, including the subdirectory /MySubdirectory, user Admin, and password.

JSON

{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Description": "Specifies an FSx for Windows File Server 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-12345678901212345"
                ],
                "Subdirectory": "/MySubdirectory",
                "User": "Admin",
                "Password": {
                    "Ref": "Password"
                }
            }
        }
    }
}

YAML

AWSTemplateFormatVersion: 2010-09-09
Description: Specifies an FSx for Windows File Server 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-12345678901212345
      Subdirectory: /MySubdirectory
      User: Admin
      Password: !Ref Password