This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::DataSync::LocationFSxOpenZFS
<a name="aws-resource-datasync-locationfsxopenzfs"></a>

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

## Syntax
<a name="aws-resource-datasync-locationfsxopenzfs-syntax"></a>

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

### JSON
<a name="aws-resource-datasync-locationfsxopenzfs-syntax.json"></a>

```
{
  "Type" : "AWS::DataSync::LocationFSxOpenZFS",
  "Properties" : {
      "[FsxFilesystemArn](#cfn-datasync-locationfsxopenzfs-fsxfilesystemarn)" : String,
      "[Protocol](#cfn-datasync-locationfsxopenzfs-protocol)" : Protocol,
      "[SecurityGroupArns](#cfn-datasync-locationfsxopenzfs-securitygrouparns)" : [ String, ... ],
      "[Subdirectory](#cfn-datasync-locationfsxopenzfs-subdirectory)" : String,
      "[Tags](#cfn-datasync-locationfsxopenzfs-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-datasync-locationfsxopenzfs-syntax.yaml"></a>

```
Type: AWS::DataSync::LocationFSxOpenZFS
Properties:
  [FsxFilesystemArn](#cfn-datasync-locationfsxopenzfs-fsxfilesystemarn): String
  [Protocol](#cfn-datasync-locationfsxopenzfs-protocol): 
    Protocol
  [SecurityGroupArns](#cfn-datasync-locationfsxopenzfs-securitygrouparns): 
    - String
  [Subdirectory](#cfn-datasync-locationfsxopenzfs-subdirectory): String
  [Tags](#cfn-datasync-locationfsxopenzfs-tags): 
    - Tag
```

## Properties
<a name="aws-resource-datasync-locationfsxopenzfs-properties"></a>

`FsxFilesystemArn`  <a name="cfn-datasync-locationfsxopenzfs-fsxfilesystemarn"></a>
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-eusc|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Protocol`  <a name="cfn-datasync-locationfsxopenzfs-protocol"></a>
The type of protocol that AWS DataSync uses to access your file system.  
*Required*: Yes  
*Type*: [Protocol](aws-properties-datasync-locationfsxopenzfs-protocol.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecurityGroupArns`  <a name="cfn-datasync-locationfsxopenzfs-securitygrouparns"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Subdirectory`  <a name="cfn-datasync-locationfsxopenzfs-subdirectory"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-datasync-locationfsxopenzfs-tags"></a>
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](aws-properties-datasync-locationfsxopenzfs-tag.md)  
*Minimum*: `0`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-datasync-locationfsxopenzfs-return-values"></a>

### Ref
<a name="aws-resource-datasync-locationfsxopenzfs-return-values-ref"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-datasync-locationfsxopenzfs-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-datasync-locationfsxopenzfs-return-values-fn--getatt-fn--getatt"></a>

`LocationArn`  <a name="LocationArn-fn::getatt"></a>
The ARN of the specified FSx for OpenZFS file system location.

`LocationUri`  <a name="LocationUri-fn::getatt"></a>
The URI of the specified FSx for OpenZFS file system location.

## Examples
<a name="aws-resource-datasync-locationfsxopenzfs--examples"></a>



### Specify an Amazon FSx for OpenZFS location for DataSync
<a name="aws-resource-datasync-locationfsxopenzfs--examples--Specify_an_Amazon_FSx_for_OpenZFS_location_for_DataSync"></a>

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

#### JSON
<a name="aws-resource-datasync-locationfsxopenzfs--examples--Specify_an_Amazon_FSx_for_OpenZFS_location_for_DataSync--json"></a>

```
{
    "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
<a name="aws-resource-datasync-locationfsxopenzfs--examples--Specify_an_Amazon_FSx_for_OpenZFS_location_for_DataSync--yaml"></a>

```
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
```

# AWS::DataSync::LocationFSxOpenZFS MountOptions
<a name="aws-properties-datasync-locationfsxopenzfs-mountoptions"></a>

Represents the mount options that are available for DataSync to access a Network File System (NFS) location.

## Syntax
<a name="aws-properties-datasync-locationfsxopenzfs-mountoptions-syntax"></a>

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

### JSON
<a name="aws-properties-datasync-locationfsxopenzfs-mountoptions-syntax.json"></a>

```
{
  "[Version](#cfn-datasync-locationfsxopenzfs-mountoptions-version)" : String
}
```

### YAML
<a name="aws-properties-datasync-locationfsxopenzfs-mountoptions-syntax.yaml"></a>

```
  [Version](#cfn-datasync-locationfsxopenzfs-mountoptions-version): String
```

## Properties
<a name="aws-properties-datasync-locationfsxopenzfs-mountoptions-properties"></a>

`Version`  <a name="cfn-datasync-locationfsxopenzfs-mountoptions-version"></a>
The specific NFS version that you want DataSync to use to mount your NFS share. If the server refuses to use the version specified, the sync will fail. If you don't specify a version, DataSync defaults to `AUTOMATIC`. That is, DataSync automatically selects a version based on negotiation with the NFS server.  
You can specify the following NFS versions:  
+ ** [NFSv3](https://tools.ietf.org/html/rfc1813) **: Stateless protocol version that allows for asynchronous writes on the server.
+ ** [NFSv4.0](https://tools.ietf.org/html/rfc3530) **: Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.
+ ** [NFSv4.1](https://tools.ietf.org/html/rfc5661) **: Stateful protocol version that supports sessions, directory delegations, and parallel data processing. Version 4.1 also includes all features available in version 4.0.
*Required*: No  
*Type*: String  
*Allowed values*: `AUTOMATIC | NFS3 | NFS4_0 | NFS4_1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DataSync::LocationFSxOpenZFS NFS
<a name="aws-properties-datasync-locationfsxopenzfs-nfs"></a>

Represents the Network File System (NFS) protocol that AWS DataSync uses to access your Amazon FSx for OpenZFS file system.

## Syntax
<a name="aws-properties-datasync-locationfsxopenzfs-nfs-syntax"></a>

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

### JSON
<a name="aws-properties-datasync-locationfsxopenzfs-nfs-syntax.json"></a>

```
{
  "[MountOptions](#cfn-datasync-locationfsxopenzfs-nfs-mountoptions)" : MountOptions
}
```

### YAML
<a name="aws-properties-datasync-locationfsxopenzfs-nfs-syntax.yaml"></a>

```
  [MountOptions](#cfn-datasync-locationfsxopenzfs-nfs-mountoptions): 
    MountOptions
```

## Properties
<a name="aws-properties-datasync-locationfsxopenzfs-nfs-properties"></a>

`MountOptions`  <a name="cfn-datasync-locationfsxopenzfs-nfs-mountoptions"></a>
Represents the mount options that are available for DataSync to access an NFS location.  
*Required*: Yes  
*Type*: [MountOptions](aws-properties-datasync-locationfsxopenzfs-mountoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DataSync::LocationFSxOpenZFS Protocol
<a name="aws-properties-datasync-locationfsxopenzfs-protocol"></a>

Represents the protocol that AWS DataSync uses to access your Amazon FSx for OpenZFS file system.

## Syntax
<a name="aws-properties-datasync-locationfsxopenzfs-protocol-syntax"></a>

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

### JSON
<a name="aws-properties-datasync-locationfsxopenzfs-protocol-syntax.json"></a>

```
{
  "[NFS](#cfn-datasync-locationfsxopenzfs-protocol-nfs)" : NFS
}
```

### YAML
<a name="aws-properties-datasync-locationfsxopenzfs-protocol-syntax.yaml"></a>

```
  [NFS](#cfn-datasync-locationfsxopenzfs-protocol-nfs): 
    NFS
```

## Properties
<a name="aws-properties-datasync-locationfsxopenzfs-protocol-properties"></a>

`NFS`  <a name="cfn-datasync-locationfsxopenzfs-protocol-nfs"></a>
Represents the Network File System (NFS) protocol that DataSync uses to access your FSx for OpenZFS file system.  
*Required*: No  
*Type*: [NFS](aws-properties-datasync-locationfsxopenzfs-nfs.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DataSync::LocationFSxOpenZFS Tag
<a name="aws-properties-datasync-locationfsxopenzfs-tag"></a>

<a name="aws-properties-datasync-locationfsxopenzfs-tag-description"></a>The `Tag` property type specifies Property description not available. for an [AWS::DataSync::LocationFSxOpenZFS](aws-resource-datasync-locationfsxopenzfs.md).

## Syntax
<a name="aws-properties-datasync-locationfsxopenzfs-tag-syntax"></a>

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

### JSON
<a name="aws-properties-datasync-locationfsxopenzfs-tag-syntax.json"></a>

```
{
  "[Key](#cfn-datasync-locationfsxopenzfs-tag-key)" : String,
  "[Value](#cfn-datasync-locationfsxopenzfs-tag-value)" : String
}
```

### YAML
<a name="aws-properties-datasync-locationfsxopenzfs-tag-syntax.yaml"></a>

```
  [Key](#cfn-datasync-locationfsxopenzfs-tag-key): String
  [Value](#cfn-datasync-locationfsxopenzfs-tag-value): String
```

## Properties
<a name="aws-properties-datasync-locationfsxopenzfs-tag-properties"></a>

`Key`  <a name="cfn-datasync-locationfsxopenzfs-tag-key"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9\s+=._:/-]+$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-datasync-locationfsxopenzfs-tag-value"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9\s+=._:@/-]+$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)