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

Class DataCatalogEncryptionAtRest

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.glue.alpha.DataCatalogEncryptionAtRest
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-08-10T14:51:27.966Z") @Stability(Experimental) public class DataCatalogEncryptionAtRest extends software.amazon.jsii.JsiiObject
(experimental) Encryption-at-rest configuration for a Glue Data Catalog.

The Data Catalog encryption at rest and the connection password encryption are independent: enabling one does not require the other, and each may use a different KMS key.

Example: 

 import software.amazon.awscdk.services.iam.*;
 Key key;
 IRole role;
 Catalog.encryptAccount(this, CatalogEncryptionOptions.builder()
         .encryptionAtRest(DataCatalogEncryptionAtRest.kmsWithServiceRole(role, key))
         .build());

See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    DataCatalogEncryptionAtRest(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    DataCatalogEncryptionAtRest(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static DataCatalogEncryptionAtRest
    disabled()
    (experimental) Disable encryption at rest for the Data Catalog.
    IKeyRef
    getKmsKey()
    (experimental) The customer-managed KMS key used for encryption at rest, if any.
    CatalogEncryptionMode
    getMode()
    (experimental) The encryption mode.
    IRole
    getServiceRole()
    (experimental) The service role that AWS Glue assumes to access the KMS key, if any.
    static DataCatalogEncryptionAtRest
    kms()
    (experimental) Encrypt the Data Catalog at rest with an AWS KMS key.
    static DataCatalogEncryptionAtRest
    kms(IKey key)
    (experimental) Encrypt the Data Catalog at rest with an AWS KMS key.
    static DataCatalogEncryptionAtRest
    kmsWithServiceRole(IRole role)
    (experimental) Encrypt the Data Catalog at rest with an AWS KMS key, accessed through a service role that AWS Glue assumes on your behalf.
    static DataCatalogEncryptionAtRest
    kmsWithServiceRole(IRole role, IKey key)
    (experimental) Encrypt the Data Catalog at rest with an AWS KMS key, accessed through a service role that AWS Glue assumes on your behalf.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • DataCatalogEncryptionAtRest

      protected DataCatalogEncryptionAtRest(software.amazon.jsii.JsiiObjectRef objRef)

    • DataCatalogEncryptionAtRest

      protected DataCatalogEncryptionAtRest(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

  • Method Details

    • disabled

      @Stability(Experimental) @NotNull public static DataCatalogEncryptionAtRest disabled()
      (experimental) Disable encryption at rest for the Data Catalog.

    • kms

      @Stability(Experimental) @NotNull public static DataCatalogEncryptionAtRest kms(@Nullable IKey key)
      (experimental) Encrypt the Data Catalog at rest with an AWS KMS key.

      Parameters:
      key - the KMS key to use.

    • kms

      @Stability(Experimental) @NotNull public static DataCatalogEncryptionAtRest kms()
      (experimental) Encrypt the Data Catalog at rest with an AWS KMS key.

    • kmsWithServiceRole

      @Stability(Experimental) @NotNull public static DataCatalogEncryptionAtRest kmsWithServiceRole(@NotNull IRole role, @Nullable IKey key)
      (experimental) Encrypt the Data Catalog at rest with an AWS KMS key, accessed through a service role that AWS Glue assumes on your behalf.

      When a customer-managed key is provided, the role is automatically granted kms:Encrypt/kms:Decrypt/kms:GenerateDataKey* on it.

      Parameters:
      role - the service role that AWS Glue assumes to access the key. This parameter is required.
      key - the KMS key to use.

    • kmsWithServiceRole

      @Stability(Experimental) @NotNull public static DataCatalogEncryptionAtRest kmsWithServiceRole(@NotNull IRole role)
      (experimental) Encrypt the Data Catalog at rest with an AWS KMS key, accessed through a service role that AWS Glue assumes on your behalf.

      When a customer-managed key is provided, the role is automatically granted kms:Encrypt/kms:Decrypt/kms:GenerateDataKey* on it.

      Parameters:
      role - the service role that AWS Glue assumes to access the key. This parameter is required.

    • getMode

      @Stability(Experimental) @NotNull public CatalogEncryptionMode getMode()
      (experimental) The encryption mode.

    • getKmsKey

      @Stability(Experimental) @Nullable public IKeyRef getKmsKey()
      (experimental) The customer-managed KMS key used for encryption at rest, if any.

    • getServiceRole

      @Stability(Experimental) @Nullable public IRole getServiceRole()
      (experimental) The service role that AWS Glue assumes to access the KMS key, if any.