CreateLocationEfsCommand

Suggest an Edit

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

Example Syntax

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

import { DataSyncClient, CreateLocationEfsCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, CreateLocationEfsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // CreateLocationEfsRequest
  Subdirectory: "STRING_VALUE",
  EfsFilesystemArn: "STRING_VALUE", // required
  Ec2Config: { // Ec2Config
    SubnetArn: "STRING_VALUE", // required
    SecurityGroupArns: [ // Ec2SecurityGroupArnList // required
      "STRING_VALUE",
    ],
  },
  Tags: [ // InputTagList
    { // TagListEntry
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE",
    },
  ],
  AccessPointArn: "STRING_VALUE",
  FileSystemAccessRoleArn: "STRING_VALUE",
  InTransitEncryption: "NONE" || "TLS1_2",
};
const command = new CreateLocationEfsCommand(input);
const response = await client.send(command);
// { // CreateLocationEfsResponse
//   LocationArn: "STRING_VALUE",
// };

CreateLocationEfsCommand Input

See CreateLocationEfsCommandInput for more details

Parameter
Type
Description
Ec2Config
Required
Ec2Config | undefined

Specifies the subnet and security groups DataSync uses to connect to one of your Amazon EFS file system's mount targets .

EfsFilesystemArn
Required
string | undefined

Specifies the ARN for your Amazon EFS file system.

AccessPointArn
string | undefined

Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to mount your Amazon EFS file system.

For more information, see Accessing restricted file systems .

FileSystemAccessRoleArn
string | undefined

Specifies an Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.

For information on creating this role, see Creating a DataSync IAM role for file system access .

InTransitEncryption
EfsInTransitEncryption | undefined

Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it transfers data to or from your Amazon EFS file system.

If you specify an access point using AccessPointArn or an IAM role using FileSystemAccessRoleArn, you must set this parameter to TLS1_2.

Subdirectory
string | undefined

Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or destination location).

By default, DataSync uses the root directory (or access point  if you provide one by using AccessPointArn). You can also include subdirectories using forward slashes (for example, /path/to/folder).

Tags
TagListEntry[] | undefined

Specifies 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.

CreateLocationEfsCommand Output

See CreateLocationEfsCommandOutput for details

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

The Amazon Resource Name (ARN) of the Amazon EFS file system location that you create.

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.