Skip to content
v2.277.0

TableEncryptionV2 Class ​

Represents server-side encryption for a DynamoDB table.

Example ​

ts
import * as cdk from 'aws-cdk-lib';
import * as kms from 'aws-cdk-lib/aws-kms';

const app = new cdk.App();
const stack = new cdk.Stack(app, 'Stack', { env: { region: 'us-west-2' } });

const tableKey = new kms.Key(stack, 'Key');
const replicaKeyArns = {
  'us-east-1': 'arn:aws:kms:us-east-1:123456789012:key/g24efbna-az9b-42ro-m3bp-cq249l94fca6',
  'us-east-2': 'arn:aws:kms:us-east-2:123456789012:key/h90bkasj-bs1j-92wp-s2ka-bh857d60bkj8',
};

const globalTable = new dynamodb.TableV2(stack, 'GlobalTable', {
  partitionKey: { name: 'pk', type: dynamodb.AttributeType.STRING },
  encryption: dynamodb.TableEncryptionV2.customerManagedKey(tableKey, replicaKeyArns),
  replicas: [
    { region: 'us-east-1' },
    { region: 'us-east-2' },
  ],
});
python
import aws_cdk as cdk
import aws_cdk.aws_kms as kms


app = cdk.App()
stack = cdk.Stack(app, "Stack", env=cdk.Environment(region="us-west-2"))

table_key = kms.Key(stack, "Key")
replica_key_arns = {
    "us-east-1": "arn:aws:kms:us-east-1:123456789012:key/g24efbna-az9b-42ro-m3bp-cq249l94fca6",
    "us-east-2": "arn:aws:kms:us-east-2:123456789012:key/h90bkasj-bs1j-92wp-s2ka-bh857d60bkj8"
}

global_table = dynamodb.TableV2(stack, "GlobalTable",
    partition_key=dynamodb.Attribute(name="pk", type=dynamodb.AttributeType.STRING),
    encryption=dynamodb.TableEncryptionV2.customer_managed_key(table_key, replica_key_arns),
    replicas=[dynamodb.ReplicaTableProps(region="us-east-1"), dynamodb.ReplicaTableProps(region="us-east-2")
    ]
)
java
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.kms.*;


App app = new App();
Stack stack = Stack.Builder.create(app, "Stack").env(Environment.builder().region("us-west-2").build()).build();

Key tableKey = new Key(stack, "Key");
Map<String, String> replicaKeyArns = Map.of(
        "us-east-1", "arn:aws:kms:us-east-1:123456789012:key/g24efbna-az9b-42ro-m3bp-cq249l94fca6",
        "us-east-2", "arn:aws:kms:us-east-2:123456789012:key/h90bkasj-bs1j-92wp-s2ka-bh857d60bkj8");

TableV2 globalTable = TableV2.Builder.create(stack, "GlobalTable")
        .partitionKey(Attribute.builder().name("pk").type(AttributeType.STRING).build())
        .encryption(TableEncryptionV2.customerManagedKey(tableKey, replicaKeyArns))
        .replicas(List.of(ReplicaTableProps.builder().region("us-east-1").build(), ReplicaTableProps.builder().region("us-east-2").build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK;
using Amazon.CDK.AWS.KMS;


var app = new App();
var stack = new Stack(app, "Stack", new StackProps { Env = new Environment { Region = "us-west-2" } });

var tableKey = new Key(stack, "Key");
IDictionary<string, string> replicaKeyArns = new Dictionary<string, string> {
    { "us-east-1", "arn:aws:kms:us-east-1:123456789012:key/g24efbna-az9b-42ro-m3bp-cq249l94fca6" },
    { "us-east-2", "arn:aws:kms:us-east-2:123456789012:key/h90bkasj-bs1j-92wp-s2ka-bh857d60bkj8" }
};

var globalTable = new TableV2(stack, "GlobalTable", new TablePropsV2 {
    PartitionKey = new Attribute { Name = "pk", Type = AttributeType.STRING },
    Encryption = TableEncryptionV2.CustomerManagedKey(tableKey, replicaKeyArns),
    Replicas = new [] { new ReplicaTableProps { Region = "us-east-1" }, new ReplicaTableProps { Region = "us-east-2" } }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import "github.com/aws/aws-cdk-go/awscdk"
import kms "github.com/aws/aws-cdk-go/awscdk"


app := cdk.NewApp()
stack := cdk.NewStack(app, jsii.String("Stack"), &StackProps{
	Env: &Environment{
		Region: jsii.String("us-west-2"),
	},
})

tableKey := kms.NewKey(stack, jsii.String("Key"))
replicaKeyArns := map[string]*string{
	"us-east-1": jsii.String("arn:aws:kms:us-east-1:123456789012:key/g24efbna-az9b-42ro-m3bp-cq249l94fca6"),
	"us-east-2": jsii.String("arn:aws:kms:us-east-2:123456789012:key/h90bkasj-bs1j-92wp-s2ka-bh857d60bkj8"),
}

globalTable := dynamodb.NewTableV2(stack, jsii.String("GlobalTable"), &TablePropsV2{
	PartitionKey: &Attribute{
		Name: jsii.String("pk"),
		Type: dynamodb.AttributeType_STRING,
	},
	Encryption: dynamodb.TableEncryptionV2_CustomerManagedKey(tableKey, replicaKeyArns),
	Replicas: []ReplicaTableProps{
		&ReplicaTableProps{
			Region: jsii.String("us-east-1"),
		},
		&ReplicaTableProps{
			Region: jsii.String("us-east-2"),
		},
	},
})

Properties ​

replicaKeyArnsmay be undefined{ [key: string]: string }replica_key_arnsmay be undefinedtyping.Mapping[str, str]replicaKeyArnsmay be undefinedMap<String, String>ReplicaKeyArnsmay be undefinedIDictionary<string, string>ReplicaKeyArnsmay be undefined*map[string]*string#
tableKeymay be undefinedIKeytable_keymay be undefinedIKeytableKeymay be undefinedIKeyTableKeymay be undefinedIKeyTableKeymay be undefinedIKey#

Methods ​

awsManagedKey(): TableEncryptionV2 // chainable@staticmethod def aws_managed_key() -> TableEncryptionV2public static TableEncryptionV2 awsManagedKey()public static TableEncryptionV2 AwsManagedKey()func AwsManagedKey() TableEncryptionV2static#
Configure server-side encryption using an AWS managed key.
customerManagedKey(tableKey: IKey, replicaKeyArns?: { [key: string]: string }): TableEncryptionV2 // chainable@staticmethod def customer_managed_key(table_key: IKey, replica_key_arns: typing.Optional[typing.Mapping[str, str]] = None) -> TableEncryptionV2public static TableEncryptionV2 customerManagedKey(IKey tableKey, Map<String, String> replicaKeyArns)public static TableEncryptionV2 CustomerManagedKey(IKey tableKey, IDictionary<string, string>? replicaKeyArns = null)func CustomerManagedKey(TableKey IKey, ReplicaKeyArns *map[string]*string) TableEncryptionV2static#
Configure server-side encryption using customer managed keys.
2 parameters

Parameters

  • tableKeytable_keytableKeytableKeyTableKey — the KMS key for the primary table.
  • replicaKeyArnsreplica_key_arnsreplicaKeyArnsreplicaKeyArnsReplicaKeyArns — an object containing the ARN of the KMS key to use for each replica table.
dynamoOwnedKey(): TableEncryptionV2 // chainable@staticmethod def dynamo_owned_key() -> TableEncryptionV2public static TableEncryptionV2 dynamoOwnedKey()public static TableEncryptionV2 DynamoOwnedKey()func DynamoOwnedKey() TableEncryptionV2static#
Configure server-side encryption using a DynamoDB owned key.