bucket_policies

Creates, updates, deletes or gets a bucket_policy resource or lists bucket_policies in a region

Overview

Name	bucket_policies
Type	Resource
Description	Resource Type Definition for AWS::S3Outposts::BucketPolicy
Id	aws.s3outposts.bucket_policies

Fields

Name	Datatype	Description
bucket	string	The Amazon Resource Name (ARN) of the specified bucket.
policy_document	object	A policy document containing permissions to add to the specified bucket.
region	string	AWS region.

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

Methods

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

SELECT examples

Gets all properties from an individual bucket_policy.

SELECT
region,
bucket,
policy_document
FROM aws.s3outposts.bucket_policies
WHERE region = 'us-east-1' AND data__Identifier = '<Bucket>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.s3outposts.bucket_policies (
 Bucket,
 PolicyDocument,
 region
)
SELECT 
'{{ Bucket }}',
 '{{ PolicyDocument }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.s3outposts.bucket_policies (
 Bucket,
 PolicyDocument,
 region
)
SELECT 
 '{{ Bucket }}',
 '{{ PolicyDocument }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: bucket_policy
    props:
      - name: Bucket
        value: '{{ Bucket }}'
      - name: PolicyDocument
        value: {}

DELETE example

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

Permissions

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

Create

s3-outposts:PutBucketPolicy,
s3-outposts:GetBucketPolicy

Read

s3-outposts:GetBucketPolicy

Update

s3-outposts:PutBucketPolicy,
s3-outposts:GetBucketPolicy

Delete

s3-outposts:DeleteBucketPolicy,
s3-outposts:GetBucketPolicy