AWS::DataSync::LocationFSxOpenZFS - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::DataSync::LocationFSxOpenZFS

The AWS::DataSync::LocationFSxOpenZFS resource specifies an endpoint for an Amazon FSx for OpenZFS file system.

Syntax

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

JSON

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

YAML

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

Properties

FsxFilesystemArn

The Amazon Resource Name (ARN) of the FSx for OpenZFS 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

Protocol

The type of protocol that AWS DataSync uses to access your file system.

Required: Yes

Type: Protocol

Update requires: No interruption

SecurityGroupArns

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

A subdirectory in the location's path that must begin with /fsx. DataSync uses this subdirectory to read or write data (depending on whether the file system is a source or destination location).

Required: No

Type: String

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

Maximum: 4096

Update requires: No interruption

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

LocationUri

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

Examples

Specify an Amazon FSx for OpenZFS location for DataSync

The following examples specify an FSx for OpenZFS location for DataSync.

JSON


{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Description": "Specifies an FSx for OpenZFS location for DataSync",
    "Resources": {
        "LocationFSxOpenZFS": {
            "Type": "AWS::DataSync::LocationFSxOpenZFS",
            "Properties": {
                "FsxFilesystemArn": "arn:aws:fsx:us-east-2:111222333444:file-system/fs-12345fsx",
                "Protocol": {
                    "NFS": {
                        "MountOptions": {
                            "Version": "NFS4_1"
                        }
                    }
                },
                "SecurityGroupArns": [
                    "arn:aws:ec2:us-east-2:11122233344:security-group/sg-12345678901212345"
                ],
                "Subdirectory": "/MySubdirectory"
            }
        }
    }
}

YAML


AWSTemplateFormatVersion: 2010-09-09
Description: Specifies an FSx for OpenZFS location for DataSync
Resources:
  LocationFSxOpenZFS:
    Type: AWS::DataSync::LocationFSxOpenZFS
    Properties:
      FsxFilesystemArn: arn:aws:fsx:us-east-2:111222333444:file-system/fs-12345fsx
      Protocol:
        NFS:
          MountOptions:
            Version: NFS4_1
      SecurityGroupArns:
        - arn:aws:ec2:us-east-2:11122233344:security-group/sg-12345678901212345
      Subdirectory: /MySubdirectory