ConnectionPasswordEncryptionProperty Struct
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 key. It then encrypts the whole connection object again if catalog encryption is also enabled.
This encryption requires that you set AWS 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.
| Source | |
|---|---|
| Type last changed |
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_glue as glue } from 'aws-cdk-lib';
const connectionPasswordEncryptionProperty: glue.CfnDataCatalogEncryptionSettings.ConnectionPasswordEncryptionProperty = {
kmsKeyId: 'kmsKeyId',
returnConnectionPasswordEncrypted: false,
};
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_glue as glue
connection_password_encryption_property = glue.CfnDataCatalogEncryptionSettings.ConnectionPasswordEncryptionProperty(
kms_key_id="kmsKeyId",
return_connection_password_encrypted=False
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.glue.*;
ConnectionPasswordEncryptionProperty connectionPasswordEncryptionProperty = ConnectionPasswordEncryptionProperty.builder()
.kmsKeyId("kmsKeyId")
.returnConnectionPasswordEncrypted(false)
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Glue;
var connectionPasswordEncryptionProperty = new ConnectionPasswordEncryptionProperty {
KmsKeyId = "kmsKeyId",
ReturnConnectionPasswordEncrypted = false
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
connectionPasswordEncryptionProperty := &ConnectionPasswordEncryptionProperty{
KmsKeyId: jsii.String("kmsKeyId"),
ReturnConnectionPasswordEncrypted: jsii.Boolean(false),
}
Properties
kmsKeyIdoptionalstringkms_key_idoptionalstrkmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptional*string #notes
If connection password protection is enabled, the caller of CreateConnection and UpdateConnection needs at least kms:Encrypt permission on the specified AWS 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.
returnConnectionPasswordEncryptedoptionalboolean | IResolvablereturn_connection_password_encryptedoptionaltyping.Union[bool, IResolvable]returnConnectionPasswordEncryptedoptionalBooleanReturnConnectionPasswordEncryptedoptionalboolReturnConnectionPasswordEncryptedoptionalinterface{} #This encryption takes effect independently from catalog encryption.