aws-cdk-lib.aws_glue.ICatalog

ICatalog Interface

A Glue Data Catalog, either the implicit account-wide catalog or one created as an AWS::Glue::Catalog resource.

ICatalog

extends

• IResource,
• ICatalogRef

implemented by

• Catalog,
• CatalogBase

Source

aws-glue/lib/catalog.ts

Type last changed

v2.270.0 · 17 Sep 2026

Properties

catalogArnstringcatalog_arnstrcatalogArnStringCatalogArnstringCatalogArn*string#

The ARN of the catalog.

catalogIdstringcatalog_idstrcatalogIdStringCatalogIdstringCatalogId*string#

The id of the catalog (for the account-wide catalog, the AWS account id).

catalogRefCatalogReferencecatalog_refCatalogReferencecatalogRefCatalogReferenceCatalogRefCatalogReferenceCatalogRefCatalogReference#

A reference to a Catalog resource.

connectionPasswordKey?may be undefinedIKeyRefconnection_password_key?may be undefinedIKeyRefconnectionPasswordKey?may be undefinedIKeyRefConnectionPasswordKey?may be undefinedIKeyRefConnectionPasswordKey?may be undefinedIKeyRef#

The customer-managed KMS key used to encrypt connection passwords, if one was configured.

Undefined when password encryption uses an AWS-managed key or is not configured. Grant access to it via KeyGrants, e.g. if (catalog.connectionPasswordKey) { KeyGrants.fromKey(catalog.connectionPasswordKey).encrypt(grantee); }.

encryptionKey?may be undefinedIKeyRefencryption_key?may be undefinedIKeyRefencryptionKey?may be undefinedIKeyRefEncryptionKey?may be undefinedIKeyRefEncryptionKey?may be undefinedIKeyRef#

The customer-managed KMS key used for the catalog's encryption at rest, if one was configured.

Undefined when encryption is disabled or an AWS-managed key is used. Grant access to it via KeyGrants, e.g. if (catalog.encryptionKey) { KeyGrants.fromKey(catalog.encryptionKey).encrypt(grantee); }.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this resource is defined.

Methods

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

• mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining