Skip to content
v2.278.0

DataCatalogEncryptionSettingsProperty Struct ​

Contains configuration information for maintaining Data Catalog security.

Example ​

ts
// 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 dataCatalogEncryptionSettingsProperty: glue.CfnDataCatalogEncryptionSettings.DataCatalogEncryptionSettingsProperty = {
  connectionPasswordEncryption: {
    kmsKeyId: 'kmsKeyId',
    returnConnectionPasswordEncrypted: false,
  },
  encryptionAtRest: {
    catalogEncryptionMode: 'catalogEncryptionMode',
    catalogEncryptionServiceRole: 'catalogEncryptionServiceRole',
    sseAwsKmsKeyId: 'sseAwsKmsKeyId',
  },
};
python
# 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

data_catalog_encryption_settings_property = glue.CfnDataCatalogEncryptionSettings.DataCatalogEncryptionSettingsProperty(
    connection_password_encryption=glue.CfnDataCatalogEncryptionSettings.ConnectionPasswordEncryptionProperty(
        kms_key_id="kmsKeyId",
        return_connection_password_encrypted=False
    ),
    encryption_at_rest=glue.CfnDataCatalogEncryptionSettings.EncryptionAtRestProperty(
        catalog_encryption_mode="catalogEncryptionMode",
        catalog_encryption_service_role="catalogEncryptionServiceRole",
        sse_aws_kms_key_id="sseAwsKmsKeyId"
    )
)
java
// 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.*;

DataCatalogEncryptionSettingsProperty dataCatalogEncryptionSettingsProperty = DataCatalogEncryptionSettingsProperty.builder()
        .connectionPasswordEncryption(ConnectionPasswordEncryptionProperty.builder()
                .kmsKeyId("kmsKeyId")
                .returnConnectionPasswordEncrypted(false)
                .build())
        .encryptionAtRest(EncryptionAtRestProperty.builder()
                .catalogEncryptionMode("catalogEncryptionMode")
                .catalogEncryptionServiceRole("catalogEncryptionServiceRole")
                .sseAwsKmsKeyId("sseAwsKmsKeyId")
                .build())
        .build();
csharp
// 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 dataCatalogEncryptionSettingsProperty = new DataCatalogEncryptionSettingsProperty {
    ConnectionPasswordEncryption = new ConnectionPasswordEncryptionProperty {
        KmsKeyId = "kmsKeyId",
        ReturnConnectionPasswordEncrypted = false
    },
    EncryptionAtRest = new EncryptionAtRestProperty {
        CatalogEncryptionMode = "catalogEncryptionMode",
        CatalogEncryptionServiceRole = "catalogEncryptionServiceRole",
        SseAwsKmsKeyId = "sseAwsKmsKeyId"
    }
};
go
// 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"

dataCatalogEncryptionSettingsProperty := &DataCatalogEncryptionSettingsProperty{
	ConnectionPasswordEncryption: &ConnectionPasswordEncryptionProperty{
		KmsKeyId: jsii.String("kmsKeyId"),
		ReturnConnectionPasswordEncrypted: jsii.Boolean(false),
	},
	EncryptionAtRest: &EncryptionAtRestProperty{
		CatalogEncryptionMode: jsii.String("catalogEncryptionMode"),
		CatalogEncryptionServiceRole: jsii.String("catalogEncryptionServiceRole"),
		SseAwsKmsKeyId: jsii.String("sseAwsKmsKeyId"),
	},
}

Properties ​

connectionPasswordEncryptionoptionalIResolvable | CfnDataCatalogEncryptionSettings.ConnectionPasswordEncryptionPropertyconnection_password_encryptionoptionaltyping.Union[IResolvable, ConnectionPasswordEncryptionProperty]connectionPasswordEncryptionoptionalIResolvableConnectionPasswordEncryptionoptionalIResolvableConnectionPasswordEncryptionoptionalinterface{} #
When connection password protection is enabled, the Data Catalog uses a customer-provided key 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.

encryptionAtRestoptionalIResolvable | CfnDataCatalogEncryptionSettings.EncryptionAtRestPropertyencryption_at_restoptionaltyping.Union[IResolvable, EncryptionAtRestProperty]encryptionAtRestoptionalIResolvableEncryptionAtRestoptionalIResolvableEncryptionAtRestoptionalinterface{} #
Specifies the encryption-at-rest configuration for the Data Catalog.