AWS::Glue::DataCatalogEncryptionSettings ConnectionPasswordEncryption - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Glue::DataCatalogEncryptionSettings ConnectionPasswordEncryption

The data structure used by the Data Catalog 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.

When a CreationConnection request arrives containing a password, the Data Catalog first encrypts the password using your Amazon KMS key. It then encrypts the whole connection object again if catalog encryption is also enabled.

This encryption requires that you set Amazon KMS key permissions to enable or restrict access on the password key according to your security requirements. For example, you might want only administrators to have decrypt permission on the password key.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "KmsKeyId" : String,
  "ReturnConnectionPasswordEncrypted" : Boolean
}

Properties

KmsKeyId

An Amazon KMS key that is used to encrypt the connection password.

If connection password protection is enabled, the caller of CreateConnection and UpdateConnection needs at least kms:Encrypt permission on the specified Amazon KMS key, to encrypt passwords before storing them in the Data Catalog. You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.

Required: No

Type: String

Update requires: No interruption

ReturnConnectionPasswordEncrypted

When the ReturnConnectionPasswordEncrypted flag is set to "true", passwords remain encrypted in the responses of GetConnection and GetConnections. This encryption takes effect independently from catalog encryption.

Required: No

Type: Boolean

Update requires: No interruption