table_encryptions

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

Overview

Name	table_encryptions
Type	Resource
Id	aws.s3tables.table_encryptions

Fields

The following fields are returned by SELECT queries:

get_table_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_encryption	select	table_bucket_arn, namespace, name, region		Gets the encryption configuration for a table. Permissions You must have the s3tables:GetTableEncryption 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
name	string	The name of the table.
namespace	string	The namespace associated with the table.
region	string	AWS region (default: us-east-1)
table_bucket_arn	string	The Amazon Resource Name (ARN) of the table bucket containing the table.

SELECT examples

get_table_encryption

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

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