AWS::DataSync::LocationFSxLustre - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

AWS::DataSync::LocationFSxLustre

The AWS::DataSync::LocationFSxLustre resource specifies an endpoint for an Amazon FSx for Lustre file system.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::DataSync::LocationFSxLustre",
  "Properties" : {
      "FsxFilesystemArn" : String,
      "SecurityGroupArns" : [ String, ... ],
      "Subdirectory" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::DataSync::LocationFSxLustre
Properties:
  FsxFilesystemArn: String
  SecurityGroupArns: 
    - String
  Subdirectory: String
  Tags: 
    - Tag

Properties

FsxFilesystemArn

Specifies the Amazon Resource Name (ARN) of the FSx for Lustre file system.

Required: No

Type: String

Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$

Maximum: 128

Update requires: Replacement

SecurityGroupArns

The ARNs of the security groups that are used to configure the FSx for Lustre 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: Array of String

Minimum: 1

Maximum: 128 | 5

Update requires: Replacement

Subdirectory

Specifies a mount path for your FSx for Lustre file system. The path can include subdirectories.

When the location is used as a source, DataSync reads data from the mount path. When the location is used as a destination, DataSync writes data to the mount path. If you don't include this parameter, DataSync uses the file system's root directory (/).

Required: No

Type: String

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

Maximum: 4096

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: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

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 Lustre file system location.

LocationUri

The URI of the specified FSx for Lustre file system location.

Examples

Specify an Amazon FSx for Lustre location for DataSync

The following examples specify an FSx for Lustre location for DataSync, including the subdirectory /MySubdirectory.

JSON


{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Description": "Specifies an FSx for Lustre location for DataSync",
    "Resources": {
        "LocationFSxLustre": {
            "Type": "AWS::DataSync::LocationFSxLustre",
            "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"
            }
        }
    }
}

YAML


AWSTemplateFormatVersion: 2010-09-09
Description: Specifies an FSx for Lustre location for DataSync
Resources:
  LocationFSxLustre:
    Type: AWS::DataSync::LocationFSxLustre
    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