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::S3Express::BucketPolicy.
Id	awscc.s3express.bucket_policies

Fields

get (all properties)

Name	Datatype	Description
bucket	string	The name of the S3 directory bucket to which the policy applies.
policy_document	object	A policy document containing permissions to add to the specified bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
bucket	string	The name of the S3 directory bucket to which the policy applies.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	bucket_policies	INSERT	Bucket, PolicyDocument, region
delete_resource	bucket_policies	DELETE	Identifier, region
update_resource	bucket_policies	UPDATE	Identifier, PatchDocument, region
list_resources	bucket_policies_list_only	SELECT	region
get_resource	bucket_policies	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual bucket_policy.

SELECT
  region,
  bucket,
  policy_document
FROM awscc.s3express.bucket_policies
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ bucket }}';

list (identifiers only)

Lists all bucket_policies in a region.

SELECT
  region,
  bucket
FROM awscc.s3express.bucket_policies_list_only
WHERE
  region = '{{ region }}';

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.s3express.bucket_policies (
  Bucket,
  PolicyDocument,
  region
)
SELECT
  '{{ bucket }}',
  '{{ policy_document }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.s3express.bucket_policies (
  Bucket,
  PolicyDocument,
  region
)
SELECT
  '{{ bucket }}',
  '{{ policy_document }}',
  '{{ 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: 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.s3express.bucket_policies
SET PatchDocument = string('{{ {
    "PolicyDocument": policy_document
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ bucket }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

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

Create

s3express:GetBucketPolicy,
s3express:PutBucketPolicy

Read

s3express:GetBucketPolicy

Update

s3express:GetBucketPolicy,
s3express:PutBucketPolicy

Delete

s3express:GetBucketPolicy,
s3express:DeleteBucketPolicy

List

s3express:GetBucketPolicy,
s3express:ListAllMyDirectoryBuckets