access_points

Creates, updates, deletes, gets or lists an access_points resource.

Overview

Name	`access_points`
Type	Resource
Id	`aws.efs.access_points`

Fields

The following fields are returned by SELECT queries:

describe_access_points

Name	Datatype	Description
`access_point_arn`	`string`	The unique Amazon Resource Name (ARN) associated with the access point. (pattern: <code>^arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:access-point/fsap-[0-9a-f]{8,40}$</code>)
`access_point_id`	`string`	The ID of the access point, assigned by Amazon EFS. (pattern: <code>^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:access-point/fsap-[0-9a-f]{8,40}\|fsap-[0-9a-f]{8,40})$</code>)
`client_token`	`string`	The opaque string specified in the request to ensure idempotent creation. (pattern: <code>.+</code>)
`file_system_id`	`string`	The ID of the EFS file system that the access point applies to. (pattern: <code>^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}\|fs-[0-9a-f]{8,40})$</code>)
`life_cycle_state`	`string`	Identifies the lifecycle phase of the access point. (creating, available, updating, deleting, deleted, error)
`name`	`string`	The name of the access point. This is the value of the Name tag.
`owner_id`	`string`	Identifies the Amazon Web Services account that owns the access point resource. (pattern: <code>^(\d{12})\|(\d{4}-\d{4}-\d{4})$</code>)
`posix_user`	`object`	The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point.
`root_directory`	`object`	Specifies the directory on the Amazon EFS file system that the access point provides access to. The access point exposes the specified file system path as the root directory of your file system to applications using the access point. NFS clients using the access point can only access data in the access point's RootDirectory and its subdirectories.
`tags`	`array`	The tags associated with the access point, presented as an array of Tag objects.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`describe_access_points`	`select`	`region`	`MaxResults`, `NextToken`, `AccessPointId`, `FileSystemId`	Returns the description of a specific Amazon EFS access point if the AccessPointId is provided. If you provide an EFS FileSystemId, it returns descriptions of all access points for that file system. You can provide either an AccessPointId or a FileSystemId in the request, but not both. This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action.
`create_access_point`	`insert`	`region`, `ClientToken`, `FileSystemId`		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 the application's own directory and any subdirectories. A file system can have a maximum of 10,000 access points unless you request an increase. To learn more, see Mounting a file system using EFS access points. If multiple requests to create access points on the same file system are sent in quick succession, and the file system is near the limit of access points, you may experience a throttling response for these requests. This is to ensure that the file system does not exceed the stated access point limit. This operation requires permissions for the elasticfilesystem:CreateAccessPoint action. Access points can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the elasticfilesystem:TagResource action to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use the elasticfilesystem:TagResource action. For more information, see Granting permissions to tag resources during creation.
`delete_access_point`	`delete`	`access_point_id`, `region`		Deletes the specified access point. After deletion is complete, new clients can no longer connect to the access points. Clients connected to the access point at the time of deletion will continue to function until they terminate their connection. This operation requires permissions for the elasticfilesystem:DeleteAccessPoint action.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`access_point_id`	`string`	The ID of the access point that you want to delete.
`region`	`string`	AWS region (default: us-east-1)
`AccessPointId`	`string`	(Optional) Specifies an EFS access point to describe in the response; mutually exclusive with FileSystemId.
`FileSystemId`	`string`	(Optional) If you provide a FileSystemId, EFS returns all access points for that file system; mutually exclusive with AccessPointId.
`MaxResults`	`integer`	(Optional) When retrieving all access points for a file system, you can optionally specify the MaxItems parameter to limit the number of objects returned in a response. The default value is 100.
`NextToken`	`string`	NextToken is present if the response is paginated. You can use NextMarker in the subsequent request to fetch the next page of access point descriptions.

`SELECT` examples

describe_access_points

Returns the description of a specific Amazon EFS access point if the AccessPointId is provided. If you provide an EFS FileSystemId, it returns descriptions of all access points for that file system. You can provide either an AccessPointId or a FileSystemId in the request, but not both. This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action.

SELECT
access_point_arn,
access_point_id,
client_token,
file_system_id,
life_cycle_state,
name,
owner_id,
posix_user,
root_directory,
tags
FROM aws.efs.access_points
WHERE region = '{{ region }}' -- required
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND AccessPointId = '{{ AccessPointId }}'
AND FileSystemId = '{{ FileSystemId }}'
;

`INSERT` examples

create_access_point
Manifest

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 the application's own directory and any subdirectories. A file system can have a maximum of 10,000 access points unless you request an increase. To learn more, see Mounting a file system using EFS access points. If multiple requests to create access points on the same file system are sent in quick succession, and the file system is near the limit of access points, you may experience a throttling response for these requests. This is to ensure that the file system does not exceed the stated access point limit. This operation requires permissions for the elasticfilesystem:CreateAccessPoint action. Access points can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the elasticfilesystem:TagResource action to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use the elasticfilesystem:TagResource action. For more information, see Granting permissions to tag resources during creation.

INSERT INTO aws.efs.access_points (
ClientToken,
Tags,
FileSystemId,
PosixUser,
RootDirectory,
region
)
SELECT 
'{{ ClientToken }}' /* required */,
'{{ Tags }}',
'{{ FileSystemId }}' /* required */,
'{{ PosixUser }}',
'{{ RootDirectory }}',
'{{ region }}'
RETURNING
access_point_arn,
access_point_id,
client_token,
file_system_id,
life_cycle_state,
name,
owner_id,
posix_user,
root_directory,
tags
;

# Description fields are for documentation purposes
- name: access_points
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the access_points resource.
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: FileSystemId
    value: "{{ FileSystemId }}"
  - name: PosixUser
    description: |
      The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point.
    value:
      Uid: {{ Uid }}
      Gid: {{ Gid }}
      SecondaryGids:
        - {{ SecondaryGids }}
  - name: RootDirectory
    description: |
      Specifies the directory on the Amazon EFS file system that the access point provides access to. The access point exposes the specified file system path as the root directory of your file system to applications using the access point. NFS clients using the access point can only access data in the access point's RootDirectory and its subdirectories.
    value:
      Path: "{{ Path }}"
      CreationInfo:
        OwnerUid: {{ OwnerUid }}
        OwnerGid: {{ OwnerGid }}
        Permissions: "{{ Permissions }}"

`DELETE` examples

delete_access_point

Deletes the specified access point. After deletion is complete, new clients can no longer connect to the access points. Clients connected to the access point at the time of deletion will continue to function until they terminate their connection. This operation requires permissions for the elasticfilesystem:DeleteAccessPoint action.

DELETE FROM aws.efs.access_points
WHERE access_point_id = '{{ access_point_id }}' --required
AND region = '{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

DELETE examples​