multi_region_access_point_policies

Creates, updates, deletes or gets a multi_region_access_point_policy resource or lists multi_region_access_point_policies in a region

Overview

Name	multi_region_access_point_policies
Type	Resource
Description	The policy to be attached to a Multi Region Access Point
Id	awscc.s3.multi_region_access_point_policies

Fields

Name	Datatype	Description
mrap_name	string	The name of the Multi Region Access Point to apply policy
policy	object	Policy document to apply to a Multi Region Access Point
▶policy_status	object	The Policy Status associated with this Multi Region Access Point
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Policy, MrapName, region
delete_resource	DELETE	Identifier, region
update_resource	UPDATE	Identifier, PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	Identifier, region

SELECT examples

Gets all properties from an individual multi_region_access_point_policy.

SELECT
  region,
  mrap_name,
  policy,
  policy_status
FROM awscc.s3.multi_region_access_point_policies
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ mrap_name }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.s3.multi_region_access_point_policies (
  MrapName,
  Policy,
  region
)
SELECT
  '{{ mrap_name }}',
  '{{ policy }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.s3.multi_region_access_point_policies (
  MrapName,
  Policy,
  region
)
SELECT
  '{{ mrap_name }}',
  '{{ 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: multi_region_access_point_policy
  props:
    - name: mrap_name
      value: '{{ mrap_name }}'
    - name: policy
      value: {}

UPDATE example

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

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

DELETE example

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

Update

s3:PutMultiRegionAccessPointPolicy,
s3:DescribeMultiRegionAccessPointOperation

Read

s3:GetMultiRegionAccessPointPolicy,
s3:GetMultiRegionAccessPointPolicyStatus

Delete

s3:GetMultiRegionAccessPointPolicy,
s3:GetMultiRegionAccessPoint

Create

s3:PutMultiRegionAccessPointPolicy,
s3:DescribeMultiRegionAccessPointOperation