multi_region_access_points

Creates, updates, deletes or gets a multi_region_access_point resource or lists multi_region_access_points in a region

Overview

Name	multi_region_access_points
Type	Resource
Description	AWS::S3::MultiRegionAccessPoint is an Amazon S3 resource type that dynamically routes S3 requests to easily satisfy geographic compliance requirements based on customer-defined routing policies.
Id	aws.s3.multi_region_access_points

Fields

Name	Datatype	Description
name	string	The name you want to assign to this Multi Region Access Point.
alias	string	The alias is a unique identifier to, and is part of the public DNS name for this Multi Region Access Point
created_at	string	The timestamp of the when the Multi Region Access Point is created
public_access_block_configuration	object	The PublicAccessBlock configuration that you want to apply to this Multi Region Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide.
regions	array	The list of buckets that you want to associate this Multi Region Access Point with.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Regions, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all multi_region_access_points in a region.

SELECT
region,
name,
alias,
created_at,
public_access_block_configuration,
regions
FROM aws.s3.multi_region_access_points
WHERE region = 'us-east-1';

Gets all properties from an individual multi_region_access_point.

SELECT
region,
name,
alias,
created_at,
public_access_block_configuration,
regions
FROM aws.s3.multi_region_access_points
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.s3.multi_region_access_points (
 Regions,
 region
)
SELECT 
'{{ Regions }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.s3.multi_region_access_points (
 Name,
 PublicAccessBlockConfiguration,
 Regions,
 region
)
SELECT 
 '{{ Name }}',
 '{{ PublicAccessBlockConfiguration }}',
 '{{ Regions }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: multi_region_access_point
    props:
      - name: Name
        value: '{{ Name }}'
      - name: PublicAccessBlockConfiguration
        value:
          BlockPublicAcls: '{{ BlockPublicAcls }}'
          IgnorePublicAcls: '{{ IgnorePublicAcls }}'
          BlockPublicPolicy: '{{ BlockPublicPolicy }}'
          RestrictPublicBuckets: '{{ RestrictPublicBuckets }}'
      - name: Regions
        value:
          - Bucket: '{{ Bucket }}'
            BucketAccountId: '{{ BucketAccountId }}'

DELETE example

/*+ delete */
DELETE FROM aws.s3.multi_region_access_points
WHERE data__Identifier = '<Name>'
AND region = 'us-east-1';

Permissions

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

Create

s3:CreateMultiRegionAccessPoint,
s3:DescribeMultiRegionAccessPointOperation,
s3:GetMultiRegionAccessPoint

Read

s3:GetMultiRegionAccessPoint

Delete

s3:DeleteMultiRegionAccessPoint,
s3:DescribeMultiRegionAccessPointOperation,
s3:GetMultiRegionAccessPoint

List

s3:ListMultiRegionAccessPoints