table_bucket_policies
Creates, updates, deletes, gets or lists a table_bucket_policies resource.
Overview
| Name | table_bucket_policies |
| Type | Resource |
| Id | aws.s3tables.table_bucket_policies |
Fields
The following fields are returned by SELECT queries:
- get_table_bucket_policy
| Name | Datatype | Description |
|---|---|---|
resource_policy | string | The JSON that defines the policy. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_table_bucket_policy | select | table_bucket_arn, region | Gets details about a table bucket policy. For more information, see Viewing a table bucket policy in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:GetTableBucketPolicy permission to use this operation. | |
put_table_bucket_policy | replace | table_bucket_arn, region, resourcePolicy | Creates a new table bucket policy or replaces an existing table bucket policy for a table bucket. For more information, see Adding a table bucket policy in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:PutTableBucketPolicy permission to use this operation. | |
delete_table_bucket_policy | delete | table_bucket_arn, region | Deletes a table bucket policy. For more information, see Deleting a table bucket policy in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:DeleteTableBucketPolicy permission to use this operation. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
table_bucket_arn | string | The Amazon Resource Name (ARN) of the table bucket. |
SELECT examples
- get_table_bucket_policy
Gets details about a table bucket policy. For more information, see Viewing a table bucket policy in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:GetTableBucketPolicy permission to use this operation.
SELECT
resource_policy
FROM aws.s3tables.table_bucket_policies
WHERE table_bucket_arn = '{{ table_bucket_arn }}' -- required
AND region = '{{ region }}' -- required
;
REPLACE examples
- put_table_bucket_policy
Creates a new table bucket policy or replaces an existing table bucket policy for a table bucket. For more information, see Adding a table bucket policy in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:PutTableBucketPolicy permission to use this operation.
REPLACE aws.s3tables.table_bucket_policies
SET
resourcePolicy = '{{ resourcePolicy }}'
WHERE
table_bucket_arn = '{{ table_bucket_arn }}' --required
AND region = '{{ region }}' --required
AND resourcePolicy = '{{ resourcePolicy }}' --required;
DELETE examples
- delete_table_bucket_policy
Deletes a table bucket policy. For more information, see Deleting a table bucket policy in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:DeleteTableBucketPolicy permission to use this operation.
DELETE FROM aws.s3tables.table_bucket_policies
WHERE table_bucket_arn = '{{ table_bucket_arn }}' --required
AND region = '{{ region }}' --required
;