[ aws . datasync ]

describe-location-efs

Description

Returns metadata about your DataSync location for an Amazon EFS file system.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-location-efs
--location-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--location-arn (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

LocationArn -> (string)

The ARN of the Amazon EFS file system location.

LocationUri -> (string)

The URL of the Amazon EFS file system location.

Ec2Config -> (structure)

The subnet and security groups that DataSync uses to access your Amazon EFS file system.

SubnetArn -> (string)

Specifies the ARN of a subnet where DataSync creates the network interfaces for managing traffic during your transfer.

The subnet must be located:

• In the same virtual private cloud (VPC) as the Amazon EFS file system.

• In the same Availability Zone as at least one mount target for the Amazon EFS file system.

Note

You don’t need to specify a subnet that includes a file system mount target.

SecurityGroupArns -> (list)

Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file system’s mount target.

(string)

CreationTime -> (timestamp)

The time that the location was created.

AccessPointArn -> (string)

The ARN of the access point that DataSync uses to access the Amazon EFS file system.

FileSystemAccessRoleArn -> (string)

The Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.

InTransitEncryption -> (string)

Describes whether DataSync uses Transport Layer Security (TLS) encryption when copying data to or from the Amazon EFS file system.