UpdateLocationEfsCommand

Suggest an Edit

Modifies the following configuration parameters of the Amazon EFS transfer location that you're using with DataSync.

For more information, see Configuring DataSync transfers with Amazon EFS .

Example Syntax

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

import { DataSyncClient, UpdateLocationEfsCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, UpdateLocationEfsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // UpdateLocationEfsRequest
  LocationArn: "STRING_VALUE", // required
  Subdirectory: "STRING_VALUE",
  AccessPointArn: "STRING_VALUE",
  FileSystemAccessRoleArn: "STRING_VALUE",
  InTransitEncryption: "NONE" || "TLS1_2",
};
const command = new UpdateLocationEfsCommand(input);
const response = await client.send(command);
// {};

UpdateLocationEfsCommand Input

See UpdateLocationEfsCommandInput for more details

Parameter
Type
Description
LocationArn
Required
string | undefined

Specifies the Amazon Resource Name (ARN) of the Amazon EFS transfer location that you're updating.

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 Amazon EFS 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 Amazon EFS 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).

UpdateLocationEfsCommand Output

See UpdateLocationEfsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

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.