Package software.amazon.awscdk.services.glue

Class CfnDataCatalogEncryptionSettings

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.glue.CfnDataCatalogEncryptionSettings

All Implemented Interfaces:

IInspectable, IDataCatalogEncryptionSettingsRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:39.416Z")
@Stability(Stable)
public class CfnDataCatalogEncryptionSettings
extends CfnResource
implements IInspectable, IDataCatalogEncryptionSettingsRef

Sets the security configuration for a specified catalog.

After the configuration has been set, the specified encryption is applied to every catalog write thereafter.

Example:

 // 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.*;
 CfnDataCatalogEncryptionSettings cfnDataCatalogEncryptionSettings = CfnDataCatalogEncryptionSettings.Builder.create(this, "MyCfnDataCatalogEncryptionSettings")
         .catalogId("catalogId")
         .dataCatalogEncryptionSettings(DataCatalogEncryptionSettingsProperty.builder()
                 .connectionPasswordEncryption(ConnectionPasswordEncryptionProperty.builder()
                         .kmsKeyId("kmsKeyId")
                         .returnConnectionPasswordEncrypted(false)
                         .build())
                 .encryptionAtRest(EncryptionAtRestProperty.builder()
                         .catalogEncryptionMode("catalogEncryptionMode")
                         .catalogEncryptionServiceRole("catalogEncryptionServiceRole")
                         .sseAwsKmsKeyId("sseAwsKmsKeyId")
                         .build())
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-datacatalogencryptionsettings.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnDataCatalogEncryptionSettings.Builder	A fluent builder for CfnDataCatalogEncryptionSettings.
static interface	CfnDataCatalogEncryptionSettings.ConnectionPasswordEncryptionProperty	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.
static interface	CfnDataCatalogEncryptionSettings.DataCatalogEncryptionSettingsProperty	Contains configuration information for maintaining Data Catalog security.
static interface	CfnDataCatalogEncryptionSettings.EncryptionAtRestProperty	Specifies the encryption-at-rest configuration for the Data Catalog.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.glue.IDataCatalogEncryptionSettingsRef

IDataCatalogEncryptionSettingsRef.Jsii$Default, IDataCatalogEncryptionSettingsRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDataCatalogEncryptionSettings(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDataCatalogEncryptionSettings(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDataCatalogEncryptionSettings(software.constructs.Construct scope, String id, CfnDataCatalogEncryptionSettingsProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrId()
String	getCatalogId()	The ID of the Data Catalog in which the settings are created.
protected Map<String,Object>	getCfnProperties()
Object	getDataCatalogEncryptionSettings()	Contains configuration information for maintaining Data Catalog security.
DataCatalogEncryptionSettingsReference	getDataCatalogEncryptionSettingsRef()	A reference to a DataCatalogEncryptionSettings resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCatalogId(String value)	The ID of the Data Catalog in which the settings are created.
void	setDataCatalogEncryptionSettings(IResolvable value)	Contains configuration information for maintaining Data Catalog security.
void	setDataCatalogEncryptionSettings(CfnDataCatalogEncryptionSettings.DataCatalogEncryptionSettingsProperty value)	Contains configuration information for maintaining Data Catalog security.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnDataCatalogEncryptionSettings

protected CfnDataCatalogEncryptionSettings(software.amazon.jsii.JsiiObjectRef objRef)

CfnDataCatalogEncryptionSettings

protected CfnDataCatalogEncryptionSettings(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDataCatalogEncryptionSettings

@Stability(Stable)
public CfnDataCatalogEncryptionSettings(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnDataCatalogEncryptionSettingsProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDataCatalogEncryptionSettingsRef

@Stability(Stable)
@NotNull
public DataCatalogEncryptionSettingsReference getDataCatalogEncryptionSettingsRef()

A reference to a DataCatalogEncryptionSettings resource.

Specified by:

getDataCatalogEncryptionSettingsRef in interface IDataCatalogEncryptionSettingsRef

getCatalogId

@Stability(Stable)
@NotNull
public String getCatalogId()

The ID of the Data Catalog in which the settings are created.

setCatalogId

@Stability(Stable)
public void setCatalogId(@NotNull
 String value)

The ID of the Data Catalog in which the settings are created.

getDataCatalogEncryptionSettings

@Stability(Stable)
@NotNull
public Object getDataCatalogEncryptionSettings()

Contains configuration information for maintaining Data Catalog security.

Returns union: either IResolvable or CfnDataCatalogEncryptionSettings.DataCatalogEncryptionSettingsProperty

setDataCatalogEncryptionSettings

@Stability(Stable)
public void setDataCatalogEncryptionSettings(@NotNull
 IResolvable value)

Contains configuration information for maintaining Data Catalog security.

setDataCatalogEncryptionSettings

@Stability(Stable)
public void setDataCatalogEncryptionSettings(@NotNull
 CfnDataCatalogEncryptionSettings.DataCatalogEncryptionSettingsProperty value)

Contains configuration information for maintaining Data Catalog security.