Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class AssociateFileSystemCommandProtected

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { StorageGatewayClient, AssociateFileSystemCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import
// const { StorageGatewayClient, AssociateFileSystemCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import
const client = new StorageGatewayClient(config);
const input = { // AssociateFileSystemInput
UserName: "STRING_VALUE", // required
Password: "STRING_VALUE", // required
ClientToken: "STRING_VALUE", // required
GatewayARN: "STRING_VALUE", // required
LocationARN: "STRING_VALUE", // required
Tags: [ // Tags
{ // Tag
Key: "STRING_VALUE", // required
Value: "STRING_VALUE", // required
},
],
AuditDestinationARN: "STRING_VALUE",
CacheAttributes: { // CacheAttributes
CacheStaleTimeoutInSeconds: Number("int"),
},
EndpointNetworkConfiguration: { // EndpointNetworkConfiguration
IpAddresses: [ // IpAddressList
"STRING_VALUE",
],
},
};
const command = new AssociateFileSystemCommand(input);
const response = await client.send(command);
// { // AssociateFileSystemOutput
// FileSystemAssociationARN: "STRING_VALUE",
// };

Param

AssociateFileSystemCommandInput

Returns

AssociateFileSystemCommandOutput

See

Throws

InternalServerError (server fault)

An internal server error has occurred during the request. For more information, see the error and message fields.

Throws

InvalidGatewayRequestException (client fault)

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

Throws

StorageGatewayServiceException

Base exception class for all service exceptions from StorageGateway service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods