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	Resource Type Definition for AWS::S3Outposts::AccessPoint
Id	awscc.s3outposts.access_points

Fields

get (all properties)

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the specified AccessPoint.
bucket	string	The Amazon Resource Name (ARN) of the bucket you want to associate this AccessPoint with.
name	string	A name for the AccessPoint.
▶vpc_configuration	object	Virtual Private Cloud (VPC) from which requests can be made to the AccessPoint.
policy	object	The access point policy associated with this access point.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the specified AccessPoint.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	access_points	INSERT	Bucket, Name, VpcConfiguration, 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,
  arn,
  bucket,
  name,
  vpc_configuration,
  policy
FROM awscc.s3outposts.access_points
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all access_points in a region.

SELECT
  region,
  arn
FROM awscc.s3outposts.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.s3outposts.access_points (
  Bucket,
  Name,
  VpcConfiguration,
  region
)
SELECT
  '{{ bucket }}',
  '{{ name }}',
  '{{ vpc_configuration }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.s3outposts.access_points (
  Bucket,
  Name,
  VpcConfiguration,
  Policy,
  region
)
SELECT
  '{{ bucket }}',
  '{{ name }}',
  '{{ vpc_configuration }}',
  '{{ policy }}',
  '{{ 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: bucket
      value: '{{ bucket }}'
    - name: name
      value: '{{ name }}'
    - name: vpc_configuration
      value:
        vpc_id: '{{ vpc_id }}'
    - name: policy
      value: {}

UPDATE example

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

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

DELETE example

/*+ delete */
DELETE FROM awscc.s3outposts.access_points
WHERE
  Identifier = '{{ arn }}' 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

s3-outposts:CreateAccessPoint,
s3-outposts:GetAccessPoint,
s3-outposts:PutAccessPointPolicy,
s3-outposts:GetAccessPointPolicy

Read

s3-outposts:GetAccessPoint,
s3-outposts:GetAccessPointPolicy

Update

s3-outposts:GetAccessPoint,
s3-outposts:PutAccessPointPolicy,
s3-outposts:GetAccessPointPolicy,
s3-outposts:DeleteAccessPointPolicy

Delete

s3-outposts:DeleteAccessPoint,
s3-outposts:DeleteAccessPointPolicy

List

s3-outposts:ListAccessPoints