table_bucket_policies

Creates, updates, deletes or gets a table_bucket_policy resource or lists table_bucket_policies in a region

Overview

Name	table_bucket_policies
Type	Resource
Description	Applies an IAM resource policy to a table bucket.
Id	aws.s3tables.table_bucket_policies

Fields

Name	Datatype	Description
resource_policy	object	A policy document containing permissions to add to the specified table 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.
table_bucket_arn	string	The Amazon Resource Name (ARN) of the table bucket to which the policy applies.
region	string	AWS region.

For more information, see AWS::S3Tables::TableBucketPolicy.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ResourcePolicy, TableBucketARN, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all table_bucket_policies in a region.

SELECT
region,
resource_policy,
table_bucket_arn
FROM aws.s3tables.table_bucket_policies
WHERE region = 'us-east-1';

Gets all properties from an individual table_bucket_policy.

SELECT
region,
resource_policy,
table_bucket_arn
FROM aws.s3tables.table_bucket_policies
WHERE region = 'us-east-1' AND data__Identifier = '<TableBucketARN>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.s3tables.table_bucket_policies (
 ResourcePolicy,
 TableBucketARN,
 region
)
SELECT 
'{{ ResourcePolicy }}',
 '{{ TableBucketARN }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.s3tables.table_bucket_policies (
 ResourcePolicy,
 TableBucketARN,
 region
)
SELECT 
 '{{ ResourcePolicy }}',
 '{{ TableBucketARN }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: table_bucket_policy
    props:
      - name: ResourcePolicy
        value: {}
      - name: TableBucketARN
        value: '{{ TableBucketARN }}'

DELETE example

/*+ delete */
DELETE FROM aws.s3tables.table_bucket_policies
WHERE data__Identifier = '<TableBucketARN>'
AND region = 'us-east-1';

Permissions

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

Create

s3tables:GetTableBucket,
s3tables:GetTableBucketPolicy,
s3tables:PutTableBucketPolicy

Read

s3tables:GetTableBucketPolicy

Update

s3tables:GetTableBucketPolicy,
s3tables:PutTableBucketPolicy

Delete

s3tables:GetTableBucketPolicy,
s3tables:DeleteTableBucketPolicy

List

s3tables:GetTableBucketPolicy,
s3tables:ListTableBuckets