interface ICatalog 🔹

Language	Type name
.NET	`Amazon.CDK.AWS.Glue.Alpha.ICatalog`
Go	`github.com/aws/aws-cdk-go/awscdkgluealpha/v2#ICatalog`
Java	`software.amazon.awscdk.services.glue.alpha.ICatalog`
Python	`aws_cdk.aws_glue_alpha.ICatalog`
TypeScript (source)	`@aws-cdk/aws-glue-alpha` » `ICatalog`

Implements IDependable, IConstruct, IEnvironmentAware, IResource, ICatalogRef

Implemented by Catalog

Obtainable from Catalog.encryptAccount(), Catalog.forAccount(), Catalog.fromCatalogArn(), Catalog.fromCatalogId()

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

Properties

Name	Type	Description
catalogArn🔹	`string`	The ARN of the catalog.
catalogId🔹	`string`	The id of the catalog (for the account-wide catalog, the AWS account id).
catalogRef🔹	`CatalogReference`	A reference to a Catalog resource.
env🔹	`ResourceEnvironment`	The environment this resource belongs to.
node🔹	`Node`	The tree node.
stack🔹	`Stack`	The stack in which this resource is defined.
connectionPasswordKey?🔹	`IKeyRef`	The customer-managed KMS key used to encrypt connection passwords, if one was configured.
encryptionKey?🔹	`IKeyRef`	The customer-managed KMS key used for the catalog's encryption at rest, if one was configured.

catalogArn🔹

Type: string

The ARN of the catalog.

catalogId🔹

Type: string

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

catalogRef🔹

Type: CatalogReference

A reference to a Catalog resource.

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

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.

node🔹

Type: Node

The tree node.

stack🔹

Type: Stack

The stack in which this resource is defined.

connectionPasswordKey?🔹

Type: IKeyRef (optional)

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?🔹

Type: IKeyRef (optional)

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); }.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
with(...mixins)🔹	Applies one or more mixins to this construct.

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

policy RemovalPolicy

Apply the given removal policy to this resource.

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)🔹

public with(...mixins: IMixin[]): IConstruct