Class DataCatalogEncryptionAtRest

(experimental) Encryption-at-rest configuration for a Glue Data Catalog.

Inheritance

DataCatalogEncryptionAtRest

Namespace: Amazon.CDK.AWS.Glue.Alpha

Assembly: Amazon.CDK.AWS.Glue.Alpha.dll

Syntax (csharp)

public class DataCatalogEncryptionAtRest : DeputyBase

Syntax (vb)

Public Class DataCatalogEncryptionAtRest Inherits DeputyBase

Remarks

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.

Stability: Experimental

See: https://docs.aws.amazon.com/glue/latest/webapi/API_EncryptionAtRest.html

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.IAM;
             Key key;
             IRole role;

             Catalog.EncryptAccount(this, new CatalogEncryptionOptions {
                 EncryptionAtRest = DataCatalogEncryptionAtRest.KmsWithServiceRole(role, key)
             });

Synopsis

Properties

KmsKey	(experimental) The customer-managed KMS key used for encryption at rest, if any.
Mode	(experimental) The encryption mode.
ServiceRole	(experimental) The service role that AWS Glue assumes to access the KMS key, if any.

Methods

Disabled()	(experimental) Disable encryption at rest for the Data Catalog.
Kms(IKey?)	(experimental) Encrypt the Data Catalog at rest with an AWS KMS key.
KmsWithServiceRole(IRole, IKey?)	(experimental) Encrypt the Data Catalog at rest with an AWS KMS key, accessed through a service role that AWS Glue assumes on your behalf.

Properties

KmsKey

(experimental) The customer-managed KMS key used for encryption at rest, if any.

public virtual IKeyRef? KmsKey { get; }

Property Value

IKeyRef

Remarks

Stability: Experimental

Mode

(experimental) The encryption mode.

public virtual CatalogEncryptionMode Mode { get; }

Property Value

CatalogEncryptionMode

Remarks

Stability: Experimental

ServiceRole

(experimental) The service role that AWS Glue assumes to access the KMS key, if any.

public virtual IRole? ServiceRole { get; }

Property Value

IRole

Remarks

Stability: Experimental

Methods

Disabled()

(experimental) Disable encryption at rest for the Data Catalog.

public static DataCatalogEncryptionAtRest Disabled()

Returns

DataCatalogEncryptionAtRest

Remarks

Stability: Experimental

Kms(IKey?)

(experimental) Encrypt the Data Catalog at rest with an AWS KMS key.

public static DataCatalogEncryptionAtRest Kms(IKey? key = null)

Parameters

key IKey: the KMS key to use.

Returns

DataCatalogEncryptionAtRest

Remarks

Stability: Experimental

KmsWithServiceRole(IRole, IKey?)

(experimental) Encrypt the Data Catalog at rest with an AWS KMS key, accessed through a service role that AWS Glue assumes on your behalf.

public static DataCatalogEncryptionAtRest KmsWithServiceRole(IRole role, IKey? key = null)

Parameters

role IRole: the service role that AWS Glue assumes to access the key.
key IKey: the KMS key to use.

Returns

DataCatalogEncryptionAtRest

Remarks

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

Stability: Experimental