ICatalog

class aws_cdk.aws_glue_alpha.ICatalog(*args, **kwargs)

Bases: IResource, ICatalogRef, Protocol

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

Stability:: experimental

Methods

apply_removal_policy(policy)

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

Parameters:: policy (RemovalPolicy)
Return type:: None

with_(*mixins)

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.

Parameters:: mixins (IMixin) – The mixins to apply.
Return type:: IConstruct
Returns:: This construct for chaining

Attributes

catalog_arn

(experimental) The ARN of the catalog.

Stability:: experimental
Attribute:: true

catalog_id

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

Stability:: experimental
Attribute:: true

catalog_ref

(experimental) A reference to a Catalog resource.

Stability:: experimental

connection_password_key

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

Stability:: experimental

encryption_key

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

Stability:: experimental

env

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: The tree node.

stack: The stack in which this resource is defined.