class CatalogBase 🔹

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

Implements IConstruct, IDependable, IResource, IEnvironmentAware, ICatalog, ICatalogRef

Extends Resource

Implemented by Catalog

Base class for all ICatalog implementations.

Materializes the single CfnDataCatalogEncryptionSettings resource (targeting its own catalogId) from the encryption options supplied at construction. Encryption is fixed at construction, so a catalog either carries settings or it does not.

Initializer

new CatalogBase(scope: Construct, id: string, props?: ResourceProps)

Parameters

• scope Construct
• id string
• props ResourceProps

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
applyCrossStackReferenceStrength(strength)🔹	Override the cross-stack reference strength for this resource.
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
toString()🔹	Returns a string representation of this construct.
with(...mixins)🔹	Applies one or more mixins to this construct.
protected configureEncryption(options)🔹	Emit the catalog's encryption settings from the options fixed at construction.

---

applyCrossStackReferenceStrength(strength)🔹

public applyCrossStackReferenceStrength(strength: ReferenceStrength): void

Parameters

• strength ReferenceStrength — - The reference strength to use for this resource.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

---

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

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

with(...mixins)🔹

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

Parameters

• mixins IMixin

Returns

• 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. Use multiple with() calls if subsequent mixins should apply to added constructs.

---

protected configureEncryption(options)🔹

protected configureEncryption(options: CatalogEncryptionOptions): void

Parameters

• options CatalogEncryptionOptions

Emit the catalog's encryption settings from the options fixed at construction.

Subclasses call this once, after catalogId/catalogArn are assigned. When neither block is configured, no resource is emitted, avoiding an empty settings resource that would reset the catalog on deploy.