Creates a transfer location for an Amazon FSx for OpenZFS file system. AWS 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.
Note
Request parameters related to SMB aren't supported with the
CreateLocationFsxOpenZfs operation.
Request Syntax
{
"FsxFilesystemArn": "string",
"Protocol": {
"NFS": {
"MountOptions": {
"Version": "string"
}
},
"SMB": {
"Domain": "string",
"MountOptions": {
"Version": "string"
},
"Password": "string",
"User": "string"
}
},
"SecurityGroupArns": [ "string" ],
"Subdirectory": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- FsxFilesystemArn
-
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-iso|aws-iso-b):fsx:[a-z\-0-9]*:[0-9]{12}:file-system/fs-.*$Required: Yes
- Protocol
-
The type of protocol that AWS DataSync uses to access your file system.
Type: FsxProtocol object
Required: Yes
- SecurityGroupArns
-
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-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$Required: Yes
- 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).Type: String
Length Constraints: Maximum length of 4096.
Pattern:
^[^\u0000\u0085\u2028\u2029\r\n]{1,4096}$Required: No
- 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.
Type: Array of TagListEntry objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
Response Syntax
{
"LocationArn": "string"
}Response Elements
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
-
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-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalException
-
This exception is thrown when an error occurs in the AWS DataSync service.
HTTP Status Code: 500
- InvalidRequestException
-
This exception is thrown when the client submits a malformed request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
