Package software.amazon.awscdk.services.glue.alpha

Interface ConnectionPasswordEncryption

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ConnectionPasswordEncryption.Jsii$Proxy

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-08-10T14:51:27.963Z")
@Stability(Experimental)
public interface ConnectionPasswordEncryption
extends software.amazon.jsii.JsiiSerializable

(experimental) Connection-password encryption configuration for a Glue Data Catalog.

When enabled, the Data Catalog encrypts the password as part of CreateConnection or UpdateConnection and stores it in the ENCRYPTED_PASSWORD field of the connection properties. This is independent from catalog encryption at rest, and may use a different KMS key.

Example:

 Key key;
 Catalog.encryptAccount(this, CatalogEncryptionOptions.builder()
         .connectionPasswordEncryption(ConnectionPasswordEncryption.builder()
                 .kmsKey(key)
                 // Whether GetConnection/GetConnections return the password encrypted (default: true)
                 .returnConnectionPasswordEncrypted(true)
                 .build())
         .build());
 

See Also:

• https://docs.aws.amazon.com/glue/latest/webapi/API_ConnectionPasswordEncryption.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ConnectionPasswordEncryption.Builder	A builder for ConnectionPasswordEncryption
static final class	ConnectionPasswordEncryption.Jsii$Proxy	An implementation for ConnectionPasswordEncryption

Method Summary

Modifier and Type	Method	Description
static ConnectionPasswordEncryption.Builder	builder()
default IKeyRef	getKmsKey()	(experimental) The KMS key used to encrypt connection passwords.
default Boolean	getReturnConnectionPasswordEncrypted()	(experimental) Whether passwords remain encrypted in the responses of GetConnection and GetConnections.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getKmsKey

@Stability(Experimental)
@Nullable
default IKeyRef getKmsKey()

(experimental) The KMS key used to encrypt connection passwords.

Default: - an AWS-managed key is used and the key is not exposed as a grantable resource.

getReturnConnectionPasswordEncrypted

@Stability(Experimental)
@Nullable
default Boolean getReturnConnectionPasswordEncrypted()

(experimental) Whether passwords remain encrypted in the responses of GetConnection and GetConnections.

This takes effect independently from catalog encryption.

Default: true

builder

@Stability(Experimental)
static ConnectionPasswordEncryption.Builder builder()

Returns:

a ConnectionPasswordEncryption.Builder of ConnectionPasswordEncryption