table_bucket_encryptions

Creates, updates, deletes, gets or lists a table_bucket_encryptions resource.

Overview

Name	table_bucket_encryptions
Type	Resource
Id	aws.s3tables.table_bucket_encryptions

Fields

The following fields are returned by SELECT queries:

get_table_bucket_encryption

Name	Datatype	Description
kms_key_arn	string	The Amazon Resource Name (ARN) of the KMS key to use for encryption. This field is required only when sseAlgorithm is set to aws:kms. (pattern: <code>(arn:aws[-a-z0-9]:kms:[-a-z0-9]:[0-9]{12}:key/.+)</code>)
sse_algorithm	string	The server-side encryption algorithm to use. Valid values are AES256 for S3-managed encryption keys, or aws:kms for Amazon Web Services KMS-managed encryption keys. If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption. (AES256, aws:kms)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_table_bucket_encryption	select	table_bucket_arn, region		Gets the encryption configuration for a table bucket. Permissions You must have the s3tables:GetTableBucketEncryption permission to use this operation.
put_table_bucket_encryption	replace	table_bucket_arn, region, encryptionConfiguration		Sets the encryption configuration for a table bucket. Permissions You must have the s3tables:PutTableBucketEncryption permission to use this operation. If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption in the Amazon Simple Storage Service User Guide.
delete_table_bucket_encryption	delete	table_bucket_arn, region		Deletes the encryption configuration for a table bucket. Permissions You must have the s3tables:DeleteTableBucketEncryption 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_encryption

Gets the encryption configuration for a table bucket. Permissions You must have the s3tables:GetTableBucketEncryption permission to use this operation.

SELECT
kms_key_arn,
sse_algorithm
FROM aws.s3tables.table_bucket_encryptions
WHERE table_bucket_arn = '{{ table_bucket_arn }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_table_bucket_encryption

Sets the encryption configuration for a table bucket. Permissions You must have the s3tables:PutTableBucketEncryption permission to use this operation. If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption in the Amazon Simple Storage Service User Guide.

REPLACE aws.s3tables.table_bucket_encryptions
SET 
encryptionConfiguration = '{{ encryptionConfiguration }}'
WHERE 
table_bucket_arn = '{{ table_bucket_arn }}' --required
AND region = '{{ region }}' --required
AND encryptionConfiguration = '{{ encryptionConfiguration }}' --required;

DELETE examples

delete_table_bucket_encryption

Deletes the encryption configuration for a table bucket. Permissions You must have the s3tables:DeleteTableBucketEncryption permission to use this operation.

DELETE FROM aws.s3tables.table_bucket_encryptions
WHERE table_bucket_arn = '{{ table_bucket_arn }}' --required
AND region = '{{ region }}' --required
;