access_points

Creates, updates, deletes or gets an access_point resource or lists access_points in a region

Overview

Name	access_points
Type	Resource
Description	The AWS::EFS::AccessPoint resource 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.
Id	awscc.efs.access_points

Fields

get (all properties)

Name	Datatype	Description
access_point_id	string
arn	string
client_token	string	The opaque string specified in the request to ensure idempotent creation.
▶access_point_tags	array	An array of key-value pairs to apply to this resource. For more information, see Tag.
file_system_id	string	The ID of the EFS file system that the access point applies to. Accepts only the ID format for input when specifying a file system, for example fs-0123456789abcedf2.
▶posix_user	object	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.
▶root_directory	object	The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
access_point_id	string
region	string	AWS region.

For more information, see AWS::EFS::AccessPoint.

Methods

Name	Resource	Accessible by	Required Params
create_resource	access_points	INSERT	FileSystemId, region
delete_resource	access_points	DELETE	Identifier, region
update_resource	access_points	UPDATE	Identifier, PatchDocument, region
list_resources	access_points_list_only	SELECT	region
get_resource	access_points	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual access_point.

SELECT
  region,
  access_point_id,
  arn,
  client_token,
  access_point_tags,
  file_system_id,
  posix_user,
  root_directory
FROM awscc.efs.access_points
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ access_point_id }}';

list (identifiers only)

Lists all access_points in a region.

SELECT
  region,
  access_point_id
FROM awscc.efs.access_points_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new access_point resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.efs.access_points (
  FileSystemId,
  region
)
SELECT
  '{{ file_system_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.efs.access_points (
  ClientToken,
  AccessPointTags,
  FileSystemId,
  PosixUser,
  RootDirectory,
  region
)
SELECT
  '{{ client_token }}',
  '{{ access_point_tags }}',
  '{{ file_system_id }}',
  '{{ posix_user }}',
  '{{ root_directory }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: access_point
  props:
    - name: client_token
      value: '{{ client_token }}'
    - name: access_point_tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: file_system_id
      value: '{{ file_system_id }}'
    - name: posix_user
      value:
        uid: '{{ uid }}'
        gid: '{{ gid }}'
        secondary_gids:
          - '{{ secondary_gids[0] }}'
    - name: root_directory
      value:
        path: '{{ path }}'
        creation_info:
          owner_uid: '{{ owner_uid }}'
          owner_gid: '{{ owner_gid }}'
          permissions: '{{ permissions }}'

UPDATE example

Use the following StackQL query and manifest file to update a access_point resource, using stack-deploy.

/*+ update */
UPDATE awscc.efs.access_points
SET PatchDocument = string('{{ {
    "AccessPointTags": access_point_tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ access_point_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.efs.access_points
WHERE
  Identifier = '{{ access_point_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the access_points resource, the following permissions are required:

Create

elasticfilesystem:CreateAccessPoint,
elasticfilesystem:TagResource,
elasticfilesystem:DescribeAccessPoints

Read

elasticfilesystem:DescribeAccessPoints

Delete

elasticfilesystem:DeleteAccessPoint,
elasticfilesystem:DescribeAccessPoints

List

elasticfilesystem:DescribeAccessPoints

Update

elasticfilesystem:DescribeAccessPoints,
elasticfilesystem:ListTagsForResource,
elasticfilesystem:TagResource,
elasticfilesystem:UntagResource