[ aws . efs ]

create-access-point

Description

Creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point’s root directory. Applications using the access point can only access data in its own directory and below. To learn more, see Mounting a File System Using EFS Access Points .

This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-access-point
[--client-token <value>]
[--tags <value>]
--file-system-id <value>
[--posix-user <value>]
[--root-directory <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--client-token (string)

A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.

--tags (list)

Creates tags associated with the access point. Each tag is a key-value pair.

(structure)

A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters:+ - = . _ : /

Key -> (string)

The tag key (String). The key can’t start with aws: .

Value -> (string)

The value of the tag key.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--file-system-id (string)

The ID of the EFS file system that the access point provides access to.

--posix-user (structure)

The operating system user and group applied to all file system requests made using the access point.

Uid -> (long)

The POSIX user ID used for all file system operations using this access point.

Gid -> (long)

The POSIX group ID used for all file system operations using this access point.

SecondaryGids -> (list)

Secondary POSIX group IDs used for all file system operations using this access point.

(long)

Shorthand Syntax:

Uid=long,Gid=long,SecondaryGids=long,long

JSON Syntax:

{
  "Uid": long,
  "Gid": long,
  "SecondaryGids": [long, ...]
}

--root-directory (structure)

Specifies the directory on the Amazon EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the RootDirectory > Path specified does not exist, EFS creates it and applies the CreationInfo settings when a client connects to an access point. When specifying a RootDirectory , you need to provide the Path , and the CreationInfo is optional.

Path -> (string)

Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the CreationInfo .

CreationInfo -> (structure)

(Optional) Specifies the POSIX IDs and permissions to apply to the access point’s RootDirectory . If the RootDirectory > Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo , you must provide values for all properties.

Warning

If you do not provide CreationInfo and the specified RootDirectory > Path does not exist, attempts to mount the file system using the access point will fail.

OwnerUid -> (long)

Specifies the POSIX user ID to apply to the RootDirectory . Accepts values from 0 to 2^32 (4294967295).

OwnerGid -> (long)

Specifies the POSIX group ID to apply to the RootDirectory . Accepts values from 0 to 2^32 (4294967295).

Permissions -> (string)

Specifies the POSIX permissions to apply to the RootDirectory , in the format of an octal number representing the file’s mode bits.

Shorthand Syntax:

Path=string,CreationInfo={OwnerUid=long,OwnerGid=long,Permissions=string}

JSON Syntax:

{
  "Path": "string",
  "CreationInfo": {
    "OwnerUid": long,
    "OwnerGid": long,
    "Permissions": "string"
  }
}

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

ClientToken -> (string)

The opaque string specified in the request to ensure idempotent creation.

Name -> (string)

The name of the access point. This is the value of the Name tag.

Tags -> (list)

The tags associated with the access point, presented as an array of Tag objects.

(structure)

A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters:+ - = . _ : /

Key -> (string)

The tag key (String). The key can’t start with aws: .

Value -> (string)

The value of the tag key.

AccessPointId -> (string)

The ID of the access point, assigned by Amazon EFS.

AccessPointArn -> (string)

The unique Amazon Resource Name (ARN) associated with the access point.

FileSystemId -> (string)

The ID of the EFS file system that the access point applies to.

PosixUser -> (structure)

The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.

Uid -> (long)

The POSIX user ID used for all file system operations using this access point.

Gid -> (long)

The POSIX group ID used for all file system operations using this access point.

SecondaryGids -> (list)

Secondary POSIX group IDs used for all file system operations using this access point.

(long)

RootDirectory -> (structure)

The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.

Path -> (string)

Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the CreationInfo .

CreationInfo -> (structure)

(Optional) Specifies the POSIX IDs and permissions to apply to the access point’s RootDirectory . If the RootDirectory > Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo , you must provide values for all properties.

Warning

If you do not provide CreationInfo and the specified RootDirectory > Path does not exist, attempts to mount the file system using the access point will fail.

OwnerUid -> (long)

Specifies the POSIX user ID to apply to the RootDirectory . Accepts values from 0 to 2^32 (4294967295).

OwnerGid -> (long)

Specifies the POSIX group ID to apply to the RootDirectory . Accepts values from 0 to 2^32 (4294967295).

Permissions -> (string)

Specifies the POSIX permissions to apply to the RootDirectory , in the format of an octal number representing the file’s mode bits.

OwnerId -> (string)

Identified the AWS account that owns the access point resource.

LifeCycleState -> (string)

Identifies the lifecycle phase of the access point.