ConnectionPasswordEncryption (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.glue.model.ConnectionPasswordEncryption

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ConnectionPasswordEncryption
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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, and 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 may want only admin users to have decrypt permission on the password key.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ConnectionPasswordEncryption()

Constructors
Constructor and Description
`ConnectionPasswordEncryption()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConnectionPasswordEncryption`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAwsKmsKeyId()` A KMS key used to protect access to the JDBC source.
`Boolean`	`getReturnConnectionPasswordEncrypted()` When the `ReturnConnectionPasswordEncrypted` flag is set to "true", passwords remain encrypted in the responses of `GetConnection` and `GetConnections`.
`int`	`hashCode()`
`Boolean`	`isReturnConnectionPasswordEncrypted()` When the `ReturnConnectionPasswordEncrypted` flag is set to "true", passwords remain encrypted in the responses of `GetConnection` and `GetConnections`.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAwsKmsKeyId(String awsKmsKeyId)` A KMS key used to protect access to the JDBC source.
`void`	`setReturnConnectionPasswordEncrypted(Boolean returnConnectionPasswordEncrypted)` When the `ReturnConnectionPasswordEncrypted` flag is set to "true", passwords remain encrypted in the responses of `GetConnection` and `GetConnections`.
`String`	`toString()` Returns a string representation of this object.
`ConnectionPasswordEncryption`	`withAwsKmsKeyId(String awsKmsKeyId)` A KMS key used to protect access to the JDBC source.
`ConnectionPasswordEncryption`	`withReturnConnectionPasswordEncrypted(Boolean returnConnectionPasswordEncrypted)` When the `ReturnConnectionPasswordEncrypted` flag is set to "true", passwords remain encrypted in the responses of `GetConnection` and `GetConnections`.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ConnectionPasswordEncryption
```
public ConnectionPasswordEncryption()
```
- Method Detail
  - setReturnConnectionPasswordEncrypted
```
public void setReturnConnectionPasswordEncrypted(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.
    
    Parameters:
    
    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.
  - getReturnConnectionPasswordEncrypted
```
public Boolean getReturnConnectionPasswordEncrypted()
```
    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.
  - withReturnConnectionPasswordEncrypted
```
public ConnectionPasswordEncryption withReturnConnectionPasswordEncrypted(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isReturnConnectionPasswordEncrypted
```
public Boolean isReturnConnectionPasswordEncrypted()
```
    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.
  - setAwsKmsKeyId
```
public void setAwsKmsKeyId(String awsKmsKeyId)
```
    A KMS key used to protect access to the JDBC source.
    
    All users in your account should be granted the kms:encrypt permission to encrypt passwords before storing them in the Data Catalog (through the AWS Glue CreateConnection operation).
    
    The decrypt permission should be granted only to KMS key admins and IAM roles designated for AWS Glue crawlers.
    
    Parameters:
    
    awsKmsKeyId - A KMS key used to protect access to the JDBC source.
    
    All users in your account should be granted the kms:encrypt permission to encrypt passwords before storing them in the Data Catalog (through the AWS Glue CreateConnection operation).
    
    The decrypt permission should be granted only to KMS key admins and IAM roles designated for AWS Glue crawlers.
  - getAwsKmsKeyId
```
public String getAwsKmsKeyId()
```
    A KMS key used to protect access to the JDBC source.
    
    All users in your account should be granted the kms:encrypt permission to encrypt passwords before storing them in the Data Catalog (through the AWS Glue CreateConnection operation).
    
    The decrypt permission should be granted only to KMS key admins and IAM roles designated for AWS Glue crawlers.
    
    Returns:
    
    A KMS key used to protect access to the JDBC source.
    
    All users in your account should be granted the kms:encrypt permission to encrypt passwords before storing them in the Data Catalog (through the AWS Glue CreateConnection operation).
    
    The decrypt permission should be granted only to KMS key admins and IAM roles designated for AWS Glue crawlers.
  - withAwsKmsKeyId
```
public ConnectionPasswordEncryption withAwsKmsKeyId(String awsKmsKeyId)
```
    A KMS key used to protect access to the JDBC source.
    
    All users in your account should be granted the kms:encrypt permission to encrypt passwords before storing them in the Data Catalog (through the AWS Glue CreateConnection operation).
    
    The decrypt permission should be granted only to KMS key admins and IAM roles designated for AWS Glue crawlers.
    
    Parameters:
    
    awsKmsKeyId - A KMS key used to protect access to the JDBC source.
    
    All users in your account should be granted the kms:encrypt permission to encrypt passwords before storing them in the Data Catalog (through the AWS Glue CreateConnection operation).
    
    The decrypt permission should be granted only to KMS key admins and IAM roles designated for AWS Glue crawlers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ConnectionPasswordEncryption clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ConnectionPasswordEncryption

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConnectionPasswordEncryption

Method Detail

setReturnConnectionPasswordEncrypted

getReturnConnectionPasswordEncrypted

withReturnConnectionPasswordEncrypted

isReturnConnectionPasswordEncrypted

setAwsKmsKeyId

getAwsKmsKeyId

withAwsKmsKeyId

toString

equals

hashCode

clone

marshall