Package software.amazon.awscdk.services.glue.alpha

Interface ICatalog

All Superinterfaces:
ICatalogRef, software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IResource, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
ICatalog.Jsii$Default
All Known Implementing Classes:
Catalog, CatalogBase, ICatalog.Jsii$Proxy
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-08-10T14:51:27.991Z") @Stability(Experimental) public interface ICatalog extends software.amazon.jsii.JsiiSerializable, IResource, ICatalogRef
(experimental) A Glue Data Catalog, either the implicit account-wide catalog or one created as an AWS::Glue::Catalog resource.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    ICatalog.Jsii$Default
    Internal default implementation for ICatalog.
    static final class 
    ICatalog.Jsii$Proxy
    A proxy class which represents a concrete javascript instance of this type.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCatalogArn()
    (experimental) The ARN of the catalog.
    String
    getCatalogId()
    (experimental) The id of the catalog (for the account-wide catalog, the AWS account id).
    default IKeyRef
    getConnectionPasswordKey()
    (experimental) The customer-managed KMS key used to encrypt connection passwords, if one was configured.
    default IKeyRef
    getEncryptionKey()
    (experimental) The customer-managed KMS key used for the catalog's encryption at rest, if one was configured.

    Methods inherited from interface software.amazon.awscdk.interfaces.glue.ICatalogRef

    getCatalogRef

    Methods inherited from interface software.constructs.IConstruct

    getNode, with

    Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

    getEnv

    Methods inherited from interface software.amazon.awscdk.IResource

    applyRemovalPolicy, getStack

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getCatalogArn

      @Stability(Experimental) @NotNull String getCatalogArn()
      (experimental) The ARN of the catalog.

    • getCatalogId

      @Stability(Experimental) @NotNull String getCatalogId()
      (experimental) The id of the catalog (for the account-wide catalog, the AWS account id).

    • getConnectionPasswordKey

      @Stability(Experimental) @Nullable default IKeyRef getConnectionPasswordKey()
      (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); }.

    • getEncryptionKey

      @Stability(Experimental) @Nullable default IKeyRef getEncryptionKey()
      (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); }.