AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::Glue::Model::ConnectionPasswordEncryption Class Reference

#include <ConnectionPasswordEncryption.h>

Public Member Functions

 ConnectionPasswordEncryption ()
 
 ConnectionPasswordEncryption (Aws::Utils::Json::JsonView jsonValue)
 
ConnectionPasswordEncryptionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
bool GetReturnConnectionPasswordEncrypted () const
 
bool ReturnConnectionPasswordEncryptedHasBeenSet () const
 
void SetReturnConnectionPasswordEncrypted (bool value)
 
ConnectionPasswordEncryptionWithReturnConnectionPasswordEncrypted (bool value)
 
const Aws::StringGetAwsKmsKeyId () const
 
bool AwsKmsKeyIdHasBeenSet () const
 
void SetAwsKmsKeyId (const Aws::String &value)
 
void SetAwsKmsKeyId (Aws::String &&value)
 
void SetAwsKmsKeyId (const char *value)
 
ConnectionPasswordEncryptionWithAwsKmsKeyId (const Aws::String &value)
 
ConnectionPasswordEncryptionWithAwsKmsKeyId (Aws::String &&value)
 
ConnectionPasswordEncryptionWithAwsKmsKeyId (const char *value)
 

Detailed Description

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 AWS KMS key. It then encrypts the whole connection object again if catalog encryption is also enabled.

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

AWS API Reference

Definition at line 41 of file ConnectionPasswordEncryption.h.

Constructor & Destructor Documentation

◆ ConnectionPasswordEncryption() [1/2]

Aws::Glue::Model::ConnectionPasswordEncryption::ConnectionPasswordEncryption ( )

◆ ConnectionPasswordEncryption() [2/2]

Aws::Glue::Model::ConnectionPasswordEncryption::ConnectionPasswordEncryption ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AwsKmsKeyIdHasBeenSet()

bool Aws::Glue::Model::ConnectionPasswordEncryption::AwsKmsKeyIdHasBeenSet ( ) const
inline

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

Definition at line 103 of file ConnectionPasswordEncryption.h.

◆ GetAwsKmsKeyId()

const Aws::String& Aws::Glue::Model::ConnectionPasswordEncryption::GetAwsKmsKeyId ( ) const
inline

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

Definition at line 92 of file ConnectionPasswordEncryption.h.

◆ GetReturnConnectionPasswordEncrypted()

bool Aws::Glue::Model::ConnectionPasswordEncryption::GetReturnConnectionPasswordEncrypted ( ) const
inline

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.

Definition at line 56 of file ConnectionPasswordEncryption.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Glue::Model::ConnectionPasswordEncryption::Jsonize ( ) const

◆ operator=()

ConnectionPasswordEncryption& Aws::Glue::Model::ConnectionPasswordEncryption::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ReturnConnectionPasswordEncryptedHasBeenSet()

bool Aws::Glue::Model::ConnectionPasswordEncryption::ReturnConnectionPasswordEncryptedHasBeenSet ( ) const
inline

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.

Definition at line 64 of file ConnectionPasswordEncryption.h.

◆ SetAwsKmsKeyId() [1/3]

void Aws::Glue::Model::ConnectionPasswordEncryption::SetAwsKmsKeyId ( const Aws::String value)
inline

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

Definition at line 114 of file ConnectionPasswordEncryption.h.

◆ SetAwsKmsKeyId() [2/3]

void Aws::Glue::Model::ConnectionPasswordEncryption::SetAwsKmsKeyId ( Aws::String &&  value)
inline

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

Definition at line 125 of file ConnectionPasswordEncryption.h.

◆ SetAwsKmsKeyId() [3/3]

void Aws::Glue::Model::ConnectionPasswordEncryption::SetAwsKmsKeyId ( const char *  value)
inline

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

Definition at line 136 of file ConnectionPasswordEncryption.h.

◆ SetReturnConnectionPasswordEncrypted()

void Aws::Glue::Model::ConnectionPasswordEncryption::SetReturnConnectionPasswordEncrypted ( bool  value)
inline

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.

Definition at line 72 of file ConnectionPasswordEncryption.h.

◆ WithAwsKmsKeyId() [1/3]

ConnectionPasswordEncryption& Aws::Glue::Model::ConnectionPasswordEncryption::WithAwsKmsKeyId ( const Aws::String value)
inline

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

Definition at line 147 of file ConnectionPasswordEncryption.h.

◆ WithAwsKmsKeyId() [2/3]

ConnectionPasswordEncryption& Aws::Glue::Model::ConnectionPasswordEncryption::WithAwsKmsKeyId ( Aws::String &&  value)
inline

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

Definition at line 158 of file ConnectionPasswordEncryption.h.

◆ WithAwsKmsKeyId() [3/3]

ConnectionPasswordEncryption& Aws::Glue::Model::ConnectionPasswordEncryption::WithAwsKmsKeyId ( const char *  value)
inline

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

Definition at line 169 of file ConnectionPasswordEncryption.h.

◆ WithReturnConnectionPasswordEncrypted()

ConnectionPasswordEncryption& Aws::Glue::Model::ConnectionPasswordEncryption::WithReturnConnectionPasswordEncrypted ( bool  value)
inline

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.

Definition at line 80 of file ConnectionPasswordEncryption.h.


The documentation for this class was generated from the following file: