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	aws.s3outposts.access_points

Fields

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.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Bucket, Name, VpcConfiguration, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all access_points in a region.

SELECT
region,
arn,
bucket,
name,
vpc_configuration,
policy
FROM aws.s3outposts.access_points
WHERE region = 'us-east-1';

Gets all properties from an individual access_point.

SELECT
region,
arn,
bucket,
name,
vpc_configuration,
policy
FROM aws.s3outposts.access_points
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

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 aws.s3outposts.access_points (
 Bucket,
 Name,
 VpcConfiguration,
 region
)
SELECT 
'{{ Bucket }}',
 '{{ Name }}',
 '{{ VpcConfiguration }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.s3outposts.access_points (
 Bucket,
 Name,
 VpcConfiguration,
 Policy,
 region
)
SELECT 
 '{{ Bucket }}',
 '{{ Name }}',
 '{{ VpcConfiguration }}',
 '{{ Policy }}',
 '{{ region }}';

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: VpcConfiguration
        value:
          VpcId: '{{ VpcId }}'
      - name: Policy
        value: {}

DELETE example

/*+ delete */
DELETE FROM aws.s3outposts.access_points
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

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