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	awscc.s3.multi_region_access_points

Fields

get (all properties)

Name	Datatype	Description
▶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.
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
▶regions	array	The list of buckets that you want to associate this Multi Region Access Point with.
name	string	The name you want to assign to this Multi Region Access Point.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
name	string	The name you want to assign to this Multi Region Access Point.
region	string	AWS region.

For more information, see AWS::S3::MultiRegionAccessPoint.

Methods

Name	Resource	Accessible by	Required Params
create_resource	multi_region_access_points	INSERT	Regions, region
delete_resource	multi_region_access_points	DELETE	Identifier, region
list_resources	multi_region_access_points_list_only	SELECT	region
get_resource	multi_region_access_points	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual multi_region_access_point.

SELECT
  region,
  public_access_block_configuration,
  alias,
  created_at,
  regions,
  name
FROM awscc.s3.multi_region_access_points
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all multi_region_access_points in a region.

SELECT
  region,
  name
FROM awscc.s3.multi_region_access_points_list_only
WHERE
  region = '{{ region }}';

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 awscc.s3.multi_region_access_points (
  Regions,
  region
)
SELECT
  '{{ regions }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.s3.multi_region_access_points (
  PublicAccessBlockConfiguration,
  Regions,
  Name,
  region
)
SELECT
  '{{ public_access_block_configuration }}',
  '{{ regions }}',
  '{{ name }}',
  '{{ 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: multi_region_access_point
  props:
    - name: public_access_block_configuration
      value:
        restrict_public_buckets: '{{ restrict_public_buckets }}'
        block_public_policy: '{{ block_public_policy }}'
        block_public_acls: '{{ block_public_acls }}'
        ignore_public_acls: '{{ ignore_public_acls }}'
    - name: regions
      value:
        - bucket: '{{ bucket }}'
          bucket_account_id: '{{ bucket_account_id }}'
    - name: name
      value: '{{ name }}'

DELETE example

/*+ delete */
DELETE FROM awscc.s3.multi_region_access_points
WHERE
  Identifier = '{{ name }}' 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 multi_region_access_points resource, the following permissions are required:

Read

s3:GetMultiRegionAccessPoint

Create

s3:CreateMultiRegionAccessPoint,
s3:DescribeMultiRegionAccessPointOperation,
s3:GetMultiRegionAccessPoint

List

s3:ListMultiRegionAccessPoints

Delete

s3:DeleteMultiRegionAccessPoint,
s3:DescribeMultiRegionAccessPointOperation,
s3:GetMultiRegionAccessPoint