Package software.amazon.awscdk.services.dynamodb

@Stability(Stable) @Deprecated package software.amazon.awscdk.services.dynamodb
Deprecated.

Amazon DynamoDB Construct Library

---

End-of-Support

AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2.

For more information on how to migrate, see the Migrating to AWS CDK v2 guide.

Here is a minimal deployable DynamoDB table definition: 

 Table table = Table.Builder.create(this, "Table")
         .partitionKey(Attribute.builder().name("id").type(AttributeType.STRING).build())
         .build();

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: 

 User user;
 
 ITable 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.

 Table table = Table.Builder.create(this, "Table")
         .partitionKey(Attribute.builder().name("id").type(AttributeType.STRING).build())
         .billingMode(BillingMode.PAY_PER_REQUEST)
         .build();

Further reading: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.

Table Class

DynamoDB supports two table classes:

  • STANDARD - the default mode, and is recommended for the vast majority of workloads.
  • STANDARD_INFREQUENT_ACCESS - optimized for tables where storage is the dominant cost.

 Table table = Table.Builder.create(this, "Table")
         .partitionKey(Attribute.builder().name("id").type(AttributeType.STRING).build())
         .tableClass(TableClass.STANDARD_INFREQUENT_ACCESS)
         .build();

Further reading: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.TableClasses.html

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. 

 IScalableTableAttribute readScaling = table.autoScaleReadCapacity(EnableScalingProps.builder().minCapacity(1).maxCapacity(50).build());
 
 readScaling.scaleOnUtilization(UtilizationScalingProps.builder()
         .targetUtilizationPercent(50)
         .build());
 
 readScaling.scaleOnSchedule("ScaleUpInTheMorning", ScalingSchedule.builder()
         .schedule(Schedule.cron(CronOptions.builder().hour("8").minute("0").build()))
         .minCapacity(20)
         .build());
 
 readScaling.scaleOnSchedule("ScaleDownAtNight", ScalingSchedule.builder()
         .schedule(Schedule.cron(CronOptions.builder().hour("20").minute("0").build()))
         .maxCapacity(20)
         .build());

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: 

 Table globalTable = Table.Builder.create(this, "Table")
         .partitionKey(Attribute.builder().name("id").type(AttributeType.STRING).build())
         .replicationRegions(List.of("us-east-1", "us-east-2", "us-west-2"))
         .build();

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: 

 Table globalTable = Table.Builder.create(this, "Table")
         .partitionKey(Attribute.builder().name("id").type(AttributeType.STRING).build())
         .replicationRegions(List.of("us-east-1", "us-east-2", "us-west-2"))
         .billingMode(BillingMode.PROVISIONED)
         .build();
 
 globalTable.autoScaleWriteCapacity(EnableScalingProps.builder()
         .minCapacity(1)
         .maxCapacity(10)
         .build()).scaleOnUtilization(UtilizationScalingProps.builder().targetUtilizationPercent(75).build());

When adding a replica region for a large table, you might want to increase the timeout for the replication operation: 

 Table globalTable = Table.Builder.create(this, "Table")
         .partitionKey(Attribute.builder().name("id").type(AttributeType.STRING).build())
         .replicationRegions(List.of("us-east-1", "us-east-2", "us-west-2"))
         .replicationTimeout(Duration.hours(2))
         .build();

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: 

 Table table = Table.Builder.create(this, "MyTable")
         .partitionKey(Attribute.builder().name("id").type(AttributeType.STRING).build())
         .encryption(TableEncryption.CUSTOMER_MANAGED)
         .build();
 
 // You can access the CMK that was added to the stack on your behalf by the Table construct via:
 IKey tableEncryptionKey = table.getEncryptionKey();

You can also supply your own key: 

 import software.amazon.awscdk.services.kms.*;
 
 
 Key encryptionKey = Key.Builder.create(this, "Key")
         .enableKeyRotation(true)
         .build();
 Table table = Table.Builder.create(this, "MyTable")
         .partitionKey(Attribute.builder().name("id").type(AttributeType.STRING).build())
         .encryption(TableEncryption.CUSTOMER_MANAGED)
         .encryptionKey(encryptionKey)
         .build();

In order to use the AWS managed CMK instead, change the code to: 

 Table table = Table.Builder.create(this, "MyTable")
         .partitionKey(Attribute.builder().name("id").type(AttributeType.STRING).build())
         .encryption(TableEncryption.AWS_MANAGED)
         .build();

Get schema of table or secondary indexes

To get the partition key and sort key of the table or indexes you have configured: 

 Table table;
 
 SchemaOptions schema = table.schema();
 Attribute partitionKey = schema.getPartitionKey();
 Attribute sortKey = schema.getSortKey();

Kinesis Stream

A Kinesis Data Stream can be configured on the DynamoDB table to capture item-level changes. 

 import software.amazon.awscdk.services.kinesis.*;
 
 
 Stream stream = new Stream(this, "Stream");
 
 Table table = Table.Builder.create(this, "Table")
         .partitionKey(Attribute.builder().name("id").type(AttributeType.STRING).build())
         .kinesisStream(stream)
         .build();
Deprecated: AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2. For more information on how to migrate, see https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html