CreateLocationFsxLustreCommand

Suggest an Edit

Creates a transfer location for an Amazon FSx for Lustre file system. 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 Lustre file systems .

Example Syntax

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

import { DataSyncClient, CreateLocationFsxLustreCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, CreateLocationFsxLustreCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // CreateLocationFsxLustreRequest
  FsxFilesystemArn: "STRING_VALUE", // required
  SecurityGroupArns: [ // Ec2SecurityGroupArnList // required
    "STRING_VALUE",
  ],
  Subdirectory: "STRING_VALUE",
  Tags: [ // InputTagList
    { // TagListEntry
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE",
    },
  ],
};
const command = new CreateLocationFsxLustreCommand(input);
const response = await client.send(command);
// { // CreateLocationFsxLustreResponse
//   LocationArn: "STRING_VALUE",
// };

CreateLocationFsxLustreCommand Input

See CreateLocationFsxLustreCommandInput for more details

Parameter
Type
Description
FsxFilesystemArn
Required
string | undefined

Specifies the Amazon Resource Name (ARN) of the FSx for Lustre file system.

SecurityGroupArns
Required
string[] | undefined

Specifies the Amazon Resource Names (ARNs) of up to five security groups that provide access to your FSx for Lustre file system.

The security groups must be able to access the file system's ports. The file system must also allow access from the security groups. For information about file system access, see the Amazon FSx for Lustre User Guide  .

Subdirectory
string | undefined

Specifies a mount path for your FSx for Lustre file system. The path can include subdirectories.

When the location is used as a source, DataSync reads data from the mount path. When the location is used as a destination, DataSync writes data to the mount path. If you don't include this parameter, DataSync uses the file system's root directory (/).

Tags
TagListEntry[] | undefined

Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.

CreateLocationFsxLustreCommand Output

See CreateLocationFsxLustreCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
LocationArn
string | undefined

The Amazon Resource Name (ARN) of the FSx for Lustre file system location that you created.

Throws

Name
Fault
Details
InternalException
server

This exception is thrown when an error occurs in the DataSync service.

InvalidRequestException
client

This exception is thrown when the client submits a malformed request.

DataSyncServiceException
Base exception class for all service exceptions from DataSync service.