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	awscc.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	Identifier, region
update_resource	UPDATE	Identifier, PatchDocument, region
get_resource	SELECT	Identifier, region

SELECT examples

Gets all properties from an individual bucket_policy.

SELECT
  region,
  bucket,
  policy_document
FROM awscc.s3outposts.bucket_policies
WHERE
  region = 'us-east-1' AND
  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 awscc.s3outposts.bucket_policies (
  Bucket,
  PolicyDocument,
  region
)
SELECT
  '{{ bucket }}',
  '{{ policy_document }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.s3outposts.bucket_policies (
  Bucket,
  PolicyDocument,
  region
)
SELECT
  '{{ bucket }}',
  '{{ policy_document }}',
  '{{ 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: policy_document
        value: {}

UPDATE example

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

/*+ update */
UPDATE awscc.s3outposts.bucket_policies
SET PatchDocument = string('{{ {
    "PolicyDocument": policy_document
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ bucket }}';

DELETE example

/*+ delete */
DELETE FROM awscc.s3outposts.bucket_policies
WHERE
  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