table_buckets

Creates, updates, deletes or gets a table_bucket resource or lists table_buckets in a region

Overview

Name	table_buckets
Type	Resource
Description	Creates an Amazon S3 Tables table bucket in the same AWS Region where you create the AWS CloudFormation stack.
Id	awscc.s3tables.table_buckets

Fields

get (all properties)

Name	Datatype	Description
table_bucket_arn	string	The Amazon Resource Name (ARN) of the specified table bucket.
table_bucket_name	string	A name for the table bucket.
▶unreferenced_file_removal	object	Settings governing the Unreferenced File Removal maintenance action. Unreferenced file removal identifies and deletes all objects that are not referenced by any table snapshots.
▶encryption_configuration	object	Specifies encryption settings for the table bucket
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
table_bucket_arn	string	The Amazon Resource Name (ARN) of the specified table bucket.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	table_buckets	INSERT	TableBucketName, region
delete_resource	table_buckets	DELETE	Identifier, region
update_resource	table_buckets	UPDATE	Identifier, PatchDocument, region
list_resources	table_buckets_list_only	SELECT	region
get_resource	table_buckets	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual table_bucket.

SELECT
  region,
  table_bucket_arn,
  table_bucket_name,
  unreferenced_file_removal,
  encryption_configuration
FROM awscc.s3tables.table_buckets
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ table_bucket_arn }}';

list (identifiers only)

Lists all table_buckets in a region.

SELECT
  region,
  table_bucket_arn
FROM awscc.s3tables.table_buckets_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.s3tables.table_buckets (
  TableBucketName,
  region
)
SELECT
  '{{ table_bucket_name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.s3tables.table_buckets (
  TableBucketName,
  UnreferencedFileRemoval,
  EncryptionConfiguration,
  region
)
SELECT
  '{{ table_bucket_name }}',
  '{{ unreferenced_file_removal }}',
  '{{ encryption_configuration }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: table_bucket
    props:
      - name: table_bucket_name
        value: '{{ table_bucket_name }}'
      - name: unreferenced_file_removal
        value:
          status: '{{ status }}'
          unreferenced_days: '{{ unreferenced_days }}'
          noncurrent_days: '{{ noncurrent_days }}'
      - name: encryption_configuration
        value:
          sse_algorithm: '{{ sse_algorithm }}'
          kms_key_arn: '{{ kms_key_arn }}'

UPDATE example

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

/*+ update */
UPDATE awscc.s3tables.table_buckets
SET PatchDocument = string('{{ {
    "UnreferencedFileRemoval": unreferenced_file_removal,
    "EncryptionConfiguration": encryption_configuration
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ table_bucket_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.s3tables.table_buckets
WHERE
  Identifier = '{{ table_bucket_arn }}' AND
  region = 'us-east-1';

Permissions

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

Create

s3tables:CreateTableBucket,
s3tables:PutTableBucketMaintenanceConfiguration,
s3tables:PutTableBucketEncryption,
s3tables:GetTableBucket,
s3tables:GetTableBucketMaintenanceConfiguration,
s3tables:GetTableBucketEncryption,
kms:DescribeKey

Read

s3tables:GetTableBucket,
s3tables:GetTableBucketMaintenanceConfiguration,
s3tables:GetTableBucketEncryption

Update

s3tables:PutTableBucketMaintenanceConfiguration,
s3tables:PutTableBucketEncryption,
s3tables:GetTableBucketMaintenanceConfiguration,
s3tables:GetTableBucketEncryption,
s3tables:DeleteTableBucketEncryption,
s3tables:GetTableBucket,
kms:DescribeKey

Delete

s3tables:DeleteTableBucket

List

s3tables:ListTableBuckets