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	awscc.s3tables.table_bucket_policies

Fields

get (all properties)

Name	Datatype	Description
resource_policy	object	A policy document containing permissions to add to the specified table. 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 specified 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::TableBucketPolicy.

Methods

Name	Resource	Accessible by	Required Params
create_resource	table_bucket_policies	INSERT	ResourcePolicy, TableBucketARN, region
delete_resource	table_bucket_policies	DELETE	Identifier, region
update_resource	table_bucket_policies	UPDATE	Identifier, PatchDocument, region
list_resources	table_bucket_policies_list_only	SELECT	region
get_resource	table_bucket_policies	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual table_bucket_policy.

SELECT
  region,
  resource_policy,
  table_bucket_arn
FROM awscc.s3tables.table_bucket_policies
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ table_bucket_arn }}';

list (identifiers only)

Lists all table_bucket_policies in a region.

SELECT
  region,
  table_bucket_arn
FROM awscc.s3tables.table_bucket_policies_list_only
WHERE
  region = '{{ region }}';

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 awscc.s3tables.table_bucket_policies (
  ResourcePolicy,
  TableBucketARN,
  region
)
SELECT
  '{{ resource_policy }}',
  '{{ table_bucket_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.s3tables.table_bucket_policies (
  ResourcePolicy,
  TableBucketARN,
  region
)
SELECT
  '{{ resource_policy }}',
  '{{ table_bucket_arn }}',
  '{{ 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: table_bucket_policy
  props:
    - name: resource_policy
      value: {}
    - name: table_bucket_arn
      value: '{{ table_bucket_arn }}'

UPDATE example

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

/*+ update */
UPDATE awscc.s3tables.table_bucket_policies
SET PatchDocument = string('{{ {
    "ResourcePolicy": resource_policy
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ table_bucket_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.s3tables.table_bucket_policies
WHERE
  Identifier = '{{ table_bucket_arn }}' 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 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