Package software.amazon.awssdk.services.glue.model

Class ConnectionPasswordEncryption

java.lang.Object

software.amazon.awssdk.services.glue.model.ConnectionPasswordEncryption

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ConnectionPasswordEncryption.Builder,ConnectionPasswordEncryption>

@Generated("software.amazon.awssdk:codegen")
public final class ConnectionPasswordEncryption
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ConnectionPasswordEncryption.Builder,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 KMS key. It then encrypts the whole connection object again if catalog encryption is also enabled.

This encryption requires that you set 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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConnectionPasswordEncryption.Builder

Method Summary

Modifier and Type	Method	Description
String	awsKmsKeyId()	An KMS key that is used to encrypt the connection password.
static ConnectionPasswordEncryption.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	returnConnectionPasswordEncrypted()	When the ReturnConnectionPasswordEncrypted flag is set to "true", passwords remain encrypted in the responses of GetConnection and GetConnections.
List<SdkField<?>>	sdkFields()
static Class<? extends ConnectionPasswordEncryption.Builder>	serializableBuilderClass()
ConnectionPasswordEncryption.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

returnConnectionPasswordEncrypted

public final Boolean 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.

Returns:

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.

awsKmsKeyId

public final String awsKmsKeyId()

An 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 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.

Returns:

An 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 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.

toBuilder

public ConnectionPasswordEncryption.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ConnectionPasswordEncryption.Builder,ConnectionPasswordEncryption>

builder

public static ConnectionPasswordEncryption.Builder builder()

serializableBuilderClass

public static Class<? extends ConnectionPasswordEncryption.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo