data_catalog_encryption_settings

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

Overview

Name	data_catalog_encryption_settings
Type	Resource
Id	aws.glue.data_catalog_encryption_settings

Fields

The following fields are returned by SELECT queries:

get_data_catalog_encryption_settings

Name	Datatype	Description
connection_password_encryption	object	When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part of CreateConnection or UpdateConnection and store it in the ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog encryption or only password encryption.
encryption_at_rest	object	Specifies the encryption-at-rest configuration for the Data Catalog.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_data_catalog_encryption_settings	select	region		Retrieves the security configuration for a specified catalog.
put_data_catalog_encryption_settings	replace	region, DataCatalogEncryptionSettings		Sets the security configuration for a specified catalog. After the configuration has been set, the specified encryption is applied to every catalog write thereafter.

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)

SELECT examples

get_data_catalog_encryption_settings

Retrieves the security configuration for a specified catalog.

SELECT
connection_password_encryption,
encryption_at_rest
FROM aws.glue.data_catalog_encryption_settings
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_data_catalog_encryption_settings

Sets the security configuration for a specified catalog. After the configuration has been set, the specified encryption is applied to every catalog write thereafter.

REPLACE aws.glue.data_catalog_encryption_settings
SET 
CatalogId = '{{ CatalogId }}',
DataCatalogEncryptionSettings = '{{ DataCatalogEncryptionSettings }}'
WHERE 
region = '{{ region }}' --required
AND DataCatalogEncryptionSettings = '{{ DataCatalogEncryptionSettings }}' --required;