AssociateFileSystem
Associate an Amazon FSx file system with the FSx File Gateway. After the association process is complete, the file shares on the Amazon FSx file system are available for access through the gateway. This operation only supports the FSx File Gateway type.
Request Syntax
{
"AuditDestinationARN": "string",
"CacheAttributes": {
"CacheStaleTimeoutInSeconds": number
},
"ClientToken": "string",
"EndpointNetworkConfiguration": {
"IpAddresses": [ "string" ]
},
"GatewayARN": "string",
"LocationARN": "string",
"Password": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"UserName": "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.
- AuditDestinationARN
-
The Amazon Resource Name (ARN) of the storage used for the audit logs.
Type: String
Length Constraints: Maximum length of 1024.
Required: No
- CacheAttributes
-
The refresh cache information for the file share or FSx file systems.
Type: CacheAttributes object
Required: No
- ClientToken
-
A unique string value that you supply that is used by the FSx File Gateway to ensure idempotent file system association creation.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 100.
Required: Yes
- EndpointNetworkConfiguration
-
Specifies the network configuration information for the gateway associated with the Amazon FSx file system.
Note
If multiple file systems are associated with this gateway, this parameter's
IpAddressesfield is required.Type: EndpointNetworkConfiguration object
Required: No
- GatewayARN
-
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Required: Yes
- LocationARN
-
The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.
Type: String
Length Constraints: Minimum length of 8. Maximum length of 512.
Required: Yes
- Password
-
The password of the user credential.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
^[ -~]+$Required: Yes
- Tags
-
A list of up to 50 tags that can be assigned to the file system association. Each tag is a key-value pair.
Type: Array of Tag objects
Required: No
- UserName
-
The user name of the user credential that has permission to access the root share D$ of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
^\w[\w\.\- ]*$Required: Yes
Response Syntax
{
"FileSystemAssociationARN": "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.
- FileSystemAssociationARN
-
The ARN of the newly created file system association.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An internal server error has occurred during the request. For more information, see the error and message fields.
HTTP Status Code: 400
- InvalidGatewayRequestException
-
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of AssociateFileSystem.
Sample Request
__Sample Request__
{
"UserName": "Admin",
"Password": "Password123",
"ClientToken": "foo-fsx-101",
"GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-7A8D6313",
"LocationARN": "arn:aws:fsx:us-east-1:111122223333:file-system/fs-0bb4bf5cedebd814f",
}Example
This example illustrates one usage of AssociateFileSystem.
Sample Response
__Sample Response__
{
"FileSystemAssociationARNList": ["arn:aws:storagegateway:us-east-1:111122223333:fs-association/fsa-1122AABBCCDDEEFFG"]
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
