# CreateLocationFsxOpenZfs
<a name="API_CreateLocationFsxOpenZfs"></a>

Creates a transfer *location* for an Amazon FSx for OpenZFS file system. Amazon DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand how DataSync [accesses FSx for OpenZFS file systems](https://docs.amazonaws.cn/datasync/latest/userguide/create-openzfs-location.html#create-openzfs-access).

**Note**  
Request parameters related to `SMB` aren't supported with the `CreateLocationFsxOpenZfs` operation.

## Request Syntax
<a name="API_CreateLocationFsxOpenZfs_RequestSyntax"></a>

```
{
   "FsxFilesystemArn": "{{string}}",
   "Protocol": { 
      "NFS": { 
         "MountOptions": { 
            "Version": "{{string}}"
         }
      },
      "SMB": { 
         "CmkSecretConfig": { 
            "KmsKeyArn": "{{string}}",
            "SecretArn": "{{string}}"
         },
         "CustomSecretConfig": { 
            "SecretAccessRoleArn": "{{string}}",
            "SecretArn": "{{string}}"
         },
         "Domain": "{{string}}",
         "ManagedSecretConfig": { 
            "SecretArn": "{{string}}"
         },
         "MountOptions": { 
            "Version": "{{string}}"
         },
         "Password": "{{string}}",
         "User": "{{string}}"
      }
   },
   "SecurityGroupArns": [ "{{string}}" ],
   "Subdirectory": "{{string}}",
   "Tags": [ 
      { 
         "Key": "{{string}}",
         "Value": "{{string}}"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateLocationFsxOpenZfs_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FsxFilesystemArn](#API_CreateLocationFsxOpenZfs_RequestSyntax) **   <a name="DataSync-CreateLocationFsxOpenZfs-request-FsxFilesystemArn"></a>
The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.  
Type: String  
Length Constraints: Maximum length of 128.  
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]+$`   
Required: Yes

 ** [Protocol](#API_CreateLocationFsxOpenZfs_RequestSyntax) **   <a name="DataSync-CreateLocationFsxOpenZfs-request-Protocol"></a>
The type of protocol that Amazon DataSync uses to access your file system.  
Type: [FsxProtocol](API_FsxProtocol.md) object  
Required: Yes

 ** [SecurityGroupArns](#API_CreateLocationFsxOpenZfs_RequestSyntax) **   <a name="DataSync-CreateLocationFsxOpenZfs-request-SecurityGroupArns"></a>
The ARNs of the security groups that are used to configure the FSx for OpenZFS file system.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Length Constraints: Maximum length of 128.  
Pattern: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$`   
Required: Yes

 ** [Subdirectory](#API_CreateLocationFsxOpenZfs_RequestSyntax) **   <a name="DataSync-CreateLocationFsxOpenZfs-request-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).  
Type: String  
Length Constraints: Maximum length of 4096.  
Pattern: `^[^\u0000\u0085\u2028\u2029\r\n]{1,4096}$`   
Required: No

 ** [Tags](#API_CreateLocationFsxOpenZfs_RequestSyntax) **   <a name="DataSync-CreateLocationFsxOpenZfs-request-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.  
Type: Array of [TagListEntry](API_TagListEntry.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

## Response Syntax
<a name="API_CreateLocationFsxOpenZfs_ResponseSyntax"></a>

```
{
   "LocationArn": "string"
}
```

## Response Elements
<a name="API_CreateLocationFsxOpenZfs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [LocationArn](#API_CreateLocationFsxOpenZfs_ResponseSyntax) **   <a name="DataSync-CreateLocationFsxOpenZfs-response-LocationArn"></a>
The ARN of the FSx for OpenZFS file system location that you created.  
Type: String  
Length Constraints: Maximum length of 128.  
Pattern: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$` 

## Errors
<a name="API_CreateLocationFsxOpenZfs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception is thrown when an error occurs in the Amazon DataSync service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
This exception is thrown when the client submits a malformed request.  
HTTP Status Code: 400

## See Also
<a name="API_CreateLocationFsxOpenZfs_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/datasync-2018-11-09/CreateLocationFsxOpenZfs) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationFsxOpenZfs) 
+  [Amazon SDK for C\+\+](https://docs.amazonaws.cn/goto/SdkForCpp/datasync-2018-11-09/CreateLocationFsxOpenZfs) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationFsxOpenZfs) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationFsxOpenZfs) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationFsxOpenZfs) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationFsxOpenZfs) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationFsxOpenZfs) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/datasync-2018-11-09/CreateLocationFsxOpenZfs) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationFsxOpenZfs)