CreateLocationFsxWindows
Creates an endpoint for an Amazon FSx for Windows File Server file system.
Request Syntax
{
"Domain": "string
",
"FsxFilesystemArn": "string
",
"Password": "string
",
"SecurityGroupArns": [ "string
" ],
"Subdirectory": "string
",
"Tags": [
{
"Key": "string
",
"Value": "string
"
}
],
"User": "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.
- Domain
-
Specifies the name of the Windows domain that the FSx for Windows File Server belongs to.
Type: String
Length Constraints: Maximum length of 253.
Pattern:
^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$
Required: No
- FsxFilesystemArn
-
Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server 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
- Password
-
Specifies the password of the user who has the permissions to access files and folders in the file system.
Type: String
Length Constraints: Maximum length of 104.
Pattern:
^.{0,104}$
Required: Yes
- SecurityGroupArns
-
Specifies the ARNs of the security groups that provide access to your file system's preferred subnet.
Note If you choose a security group that doesn't allow connections from within itself, do one of the following:
-
Configure the security group to allow it to communicate within itself.
-
Choose a different security group that can communicate with the mount target's security group.
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/.*$
Required: Yes
-
- Subdirectory
-
Specifies a mount path for your file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination location).
Type: String
Length Constraints: Maximum length of 4096.
Pattern:
^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$
Required: No
- Tags
-
Specifies labels that help you categorize, filter, and search for your Amazon resources. We recommend creating at least 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
- User
-
Specifies the user who has the permissions to access files and folders in the file system.
For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.
Type: String
Length Constraints: Maximum length of 104.
Pattern:
^[^\x5B\x5D\\/:;|=,+*?]{1,104}$
Required: Yes
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 Windows File Server file system location 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 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
For more information about using this API in one of the language-specific Amazon SDKs, see the following: