-
Enum Summary Enum Description AttributeType (experimental) Data types for attributes within a table.BillingMode (experimental) DynamoDB's Read/Write capacity modes.Operation (experimental) Supported DynamoDB table operations.ProjectionType (experimental) The set of attributes that are projected into the index.StreamViewType (experimental) When an item in the table is modified, StreamViewType determines what information is written to the stream for this table.TableEncryption (experimental) What kind of server-side encryption to apply to this table.
Package software.amazon.awscdk.services.dynamodb Description
Amazon DynamoDB Construct Library
---
Here is a minimal deployable DynamoDB table definition:
// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
import software.amazon.awscdk.aws_dynamodb;
Table table = new Table(this, "Table", new TableProps()
.partitionKey(new Attribute().name("id").type(dynamodb.AttributeType.getSTRING())));
Importing existing tables
To import an existing table into your CDK application, use the Table.fromTableName, Table.fromTableArn or Table.fromTableAttributes
factory method. This method accepts table name or table ARN which describes the properties of an already
existing table:
// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 Object table = Table.fromTableArn(this, "ImportedTable", "arn:aws:dynamodb:us-east-1:111111111:table/my-table"); // now you can just call methods on the table table.grantReadWriteData(user);
If you intend to use the tableStreamArn (including indirectly, for example by creating an
@aws-cdk/aws-lambda-event-source.DynamoEventSource on the imported table), you must use the
Table.fromTableAttributes method and the tableStreamArn property must be populated.
Keys
When a table is defined, you must define it's schema using the partitionKey
(required) and sortKey (optional) properties.
Billing Mode
DynamoDB supports two billing modes:
- PROVISIONED - the default mode where the table and global secondary indexes have configured read and write capacity.
- PAY_PER_REQUEST - on-demand pricing and scaling. You only pay for what you use and there is no read and write capacity for the table or its global secondary indexes.
// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
import software.amazon.awscdk.aws_dynamodb;
Table table = new Table(this, "Table", new TableProps()
.partitionKey(new Attribute().name("id").type(dynamodb.AttributeType.getSTRING()))
.billingMode(dynamodb.BillingMode.getPAY_PER_REQUEST()));
Further reading: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.
Configure AutoScaling for your table
You can have DynamoDB automatically raise and lower the read and write capacities of your table by setting up autoscaling. You can use this to either keep your tables at a desired utilization level, or by scaling up and down at pre-configured times of the day:
Auto-scaling is only relevant for tables with the billing mode, PROVISIONED.
Example of configuring autoscaling
Further reading: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/AutoScaling.html https://aws.amazon.com/blogs/database/how-to-use-aws-cloudformation-to-configure-auto-scaling-for-amazon-dynamodb-tables-and-indexes/
Amazon DynamoDB Global Tables
You can create DynamoDB Global Tables by setting the replicationRegions property on a Table:
// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
import software.amazon.awscdk.aws_dynamodb;
Table globalTable = new Table(this, "Table", new TableProps()
.partitionKey(new Attribute().name("id").type(dynamodb.AttributeType.getSTRING()))
.replicationRegions(asList("us-east-1", "us-east-2", "us-west-2")));
When doing so, a CloudFormation Custom Resource will be added to the stack in order to create the replica tables in the selected regions.
The default billing mode for Global Tables is PAY_PER_REQUEST.
If you want to use PROVISIONED,
you have to make sure write auto-scaling is enabled for that Table:
// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
Object globalTable = Table.Builder.create(this, "Table")
.partitionKey(Map.of("name", "id", "type", dynamodb.AttributeType.getSTRING()))
.replicationRegions(asList("us-east-1", "us-east-2", "us-west-2"))
.billingMode(BillingMode.getPROVISIONED())
.build();
globalTable.autoScaleWriteCapacity({
minCapacity: 1,
maxCapacity: 10,
}).scaleOnUtilization(Map.of("targetUtilizationPercent", 75));
When adding a replica region for a large table, you might want to increase the timeout for the replication operation:
// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
Object globalTable = Table.Builder.create(this, "Table")
.partitionKey(Map.of("name", "id", "type", dynamodb.AttributeType.getSTRING()))
.replicationRegions(asList("us-east-1", "us-east-2", "us-west-2"))
.replicationTimeout(Duration.hours(2))
.build();
A maximum of 10 tables with replication can be added to a stack. Consider splitting your tables across multiple stacks if your reach this limit.
Encryption
All user data stored in Amazon DynamoDB is fully encrypted at rest. When creating a new table, you can choose to encrypt using the following customer master keys (CMK) to encrypt your table:
- AWS owned CMK - By default, all tables are encrypted under an AWS owned customer master key (CMK) in the DynamoDB service account (no additional charges apply).
- AWS managed CMK - AWS KMS keys (one per region) are created in your account, managed, and used on your behalf by AWS DynamoDB (AWS KMS charges apply).
- Customer managed CMK - You have full control over the KMS key used to encrypt the DynamoDB Table (AWS KMS charges apply).
Creating a Table encrypted with a customer managed CMK:
// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
import software.amazon.awscdk.aws_dynamodb;
Table table = new Table(stack, "MyTable", new TableProps()
.partitionKey(new Attribute().name("id").type(dynamodb.AttributeType.getSTRING()))
.encryption(TableEncryption.getCUSTOMER_MANAGED()));
// You can access the CMK that was added to the stack on your behalf by the Table construct via:
Object tableEncryptionKey = table.getEncryptionKey();
You can also supply your own key:
// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
import software.amazon.awscdk.aws_dynamodb;
import software.amazon.awscdk.aws_kms;
Key encryptionKey = new Key(stack, "Key", new KeyProps()
.enableKeyRotation(true));
Table table = new Table(stack, "MyTable", new TableProps()
.partitionKey(new Attribute().name("id").type(dynamodb.AttributeType.getSTRING()))
.encryption(TableEncryption.getCUSTOMER_MANAGED())
.encryptionKey(encryptionKey));
In order to use the AWS managed CMK instead, change the code to:
// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
import software.amazon.awscdk.aws_dynamodb;
Table table = new Table(stack, "MyTable", new TableProps()
.partitionKey(new Attribute().name("id").type(dynamodb.AttributeType.getSTRING()))
.encryption(TableEncryption.getAWS_MANAGED()));