access_points

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

Overview

Name	access_points
Type	Resource
Id	aws.s3files.access_points

Fields

The following fields are returned by SELECT queries:

list_access_points

Name	Datatype	Description
name	string	The name of the access point. (pattern: <code>([\p{L}\p{Z}\p{N}_.:/=+-@]*)</code>)
access_point_arn	string	The Amazon Resource Name (ARN) of the access point. (pattern: <code>arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}/access-point/fsap-[0-9a-f]{17,40}</code>)
access_point_id	string	The ID of the access point. (pattern: <code>(arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}/access-point/fsap-[0-9a-f]{17,40}|fsap-[0-9a-f]{17,40})</code>)
file_system_id	string	The ID of the S3 File System. (pattern: <code>(arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}|fs-[0-9a-f]{17,40})</code>)
owner_id	string	The Amazon Web Services account ID of the access point owner. (pattern: <code>(\d{12})|(\d{4}-{4}-\d{4})</code>)
posix_user	object	Specifies the POSIX identity with uid, gid, and secondary group IDs for user enforcement.
root_directory	object	Specifies the root directory path and optional creation permissions for newly created directories.
status	string	The current status of the access point. (available, creating, deleting, deleted, error, updating)

get_access_point

Name	Datatype	Description
name	string	The name of the access point. (pattern: <code>([\p{L}\p{Z}\p{N}_.:/=+-@]*)</code>)
access_point_arn	string	The ARN of the access point. (pattern: <code>arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}/access-point/fsap-[0-9a-f]{17,40}</code>)
access_point_id	string	The ID of the access point. (pattern: <code>(arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}/access-point/fsap-[0-9a-f]{17,40}|fsap-[0-9a-f]{17,40})</code>)
client_token	string	The client token used for idempotency when the access point was created. (pattern: <code>(.+)</code>)
file_system_id	string	The ID of the S3 File System. (pattern: <code>(arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}|fs-[0-9a-f]{17,40})</code>)
owner_id	string	The Amazon Web Services account ID of the access point owner. (pattern: <code>(\d{12})|(\d{4}-{4}-\d{4})</code>)
posix_user	object	Specifies the POSIX identity with uid, gid, and secondary group IDs for user enforcement.
root_directory	object	Specifies the root directory path and optional creation permissions for newly created directories.
status	string	The current status of the access point. (available, creating, deleting, deleted, error, updating)
tags	array	The tags associated with the access point.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_access_points	select	fileSystemId, region	maxResults, nextToken	Returns resource information for all S3 File System Access Points associated with the specified S3 File System.
get_access_point	select	access_point_id, region		Returns resource information for an S3 File System Access Point.
create_access_point	insert	region, fileSystemId		Creates an S3 File System Access Point for application-specific access with POSIX user identity and root directory enforcement. Access points provide a way to manage access to shared datasets in multi-tenant scenarios.
delete_access_point	delete	access_point_id, region		Deletes an S3 File System Access Point. This operation is irreversible.

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 or Amazon Resource Name (ARN) of the access point to delete.
fileSystemId	string	The ID or Amazon Resource Name (ARN) of the S3 File System to list access points for.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of access points to return in a single response.
nextToken	string	A pagination token returned from a previous call to continue listing access points.

SELECT examples

list_access_points

Returns resource information for all S3 File System Access Points associated with the specified S3 File System.

SELECT
name,
access_point_arn,
access_point_id,
file_system_id,
owner_id,
posix_user,
root_directory,
status
FROM aws.s3files.access_points
WHERE fileSystemId = '{{ fileSystemId }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

get_access_point

Returns resource information for an S3 File System Access Point.

SELECT
name,
access_point_arn,
access_point_id,
client_token,
file_system_id,
owner_id,
posix_user,
root_directory,
status,
tags
FROM aws.s3files.access_points
WHERE access_point_id = '{{ access_point_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_access_point

Creates an S3 File System Access Point for application-specific access with POSIX user identity and root directory enforcement. Access points provide a way to manage access to shared datasets in multi-tenant scenarios.

INSERT INTO aws.s3files.access_points (
clientToken,
tags,
fileSystemId,
posixUser,
rootDirectory,
region
)
SELECT 
'{{ clientToken }}',
'{{ tags }}',
'{{ fileSystemId }}' /* required */,
'{{ posixUser }}',
'{{ rootDirectory }}',
'{{ region }}'
RETURNING
name,
access_point_arn,
access_point_id,
client_token,
file_system_id,
owner_id,
posix_user,
root_directory,
status,
tags
;

Manifest

# 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: |
      Specifies the POSIX identity with uid, gid, and secondary group IDs for user enforcement.
    value:
      uid: {{ uid }}
      gid: {{ gid }}
      secondaryGids:
        - {{ secondaryGids }}
  - name: rootDirectory
    description: |
      Specifies the root directory path and optional creation permissions for newly created directories.
    value:
      path: "{{ path }}"
      creationPermissions:
        ownerUid: {{ ownerUid }}
        ownerGid: {{ ownerGid }}
        permissions: "{{ permissions }}"

DELETE examples

delete_access_point

Deletes an S3 File System Access Point. This operation is irreversible.

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