Package: aws-cdk.aws-dynamodb
Amazon DynamoDB Construct Library---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 theMigrating to AWS CDK v2guide.Here is a minimal deployable DynamoDB table definition:table=dynamodb.Table(self,"Table",partition_key=dynamodb.Attribute(name="id",type=dynamodb.AttributeType.STRING))Importing existing tablesTo import an existing table into your CDK application, use theTable.fromTableName,Table.fromTableArnorTable.fromTableAttributesfactory method. This method accepts table name or table ARN which describes the properties of an already
existing table:# user: iam.Usertable=dynamodb.Table.from_table_arn(self,"ImportedTable","arn:aws:dynamodb:us-east-1:111111111:table/my-table")# now you can just call methods on the tabletable.grant_read_write_data(user)If you intend to use thetableStreamArn(including indirectly, for example by creating an@aws-cdk/aws-lambda-event-source.DynamoEventSourceon the imported table), youmustuse theTable.fromTableAttributesmethod and thetableStreamArnpropertymustbe populated.KeysWhen a table is defined, you must define it's schema using thepartitionKey(required) andsortKey(optional) properties.Billing ModeDynamoDB 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=dynamodb.Table(self,"Table",partition_key=dynamodb.Attribute(name="id",type=dynamodb.AttributeType.STRING),billing_mode=dynamodb.BillingMode.PAY_PER_REQUEST)Further reading:https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.Table ClassDynamoDB 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=dynamodb.Table(self,"Table",partition_key=dynamodb.Attribute(name="id",type=dynamodb.AttributeType.STRING),table_class=dynamodb.TableClass.STANDARD_INFREQUENT_ACCESS)Further reading:https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.TableClasses.htmlConfigure AutoScaling for your tableYou 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.read_scaling=table.auto_scale_read_capacity(min_capacity=1,max_capacity=50)read_scaling.scale_on_utilization(target_utilization_percent=50)read_scaling.scale_on_schedule("ScaleUpInTheMorning",schedule=appscaling.Schedule.cron(hour="8",minute="0"),min_capacity=20)read_scaling.scale_on_schedule("ScaleDownAtNight",schedule=appscaling.Schedule.cron(hour="20",minute="0"),max_capacity=20)Further reading:https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/AutoScaling.htmlhttps://aws.amazon.com/blogs/database/how-to-use-aws-cloudformation-to-configure-auto-scaling-for-amazon-dynamodb-tables-and-indexes/Amazon DynamoDB Global TablesYou can create DynamoDB Global Tables by setting thereplicationRegionsproperty on aTable:global_table=dynamodb.Table(self,"Table",partition_key=dynamodb.Attribute(name="id",type=dynamodb.AttributeType.STRING),replication_regions=["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 isPAY_PER_REQUEST.
If you want to usePROVISIONED,
you have to make sure write auto-scaling is enabled for that Table:global_table=dynamodb.Table(self,"Table",partition_key=dynamodb.Attribute(name="id",type=dynamodb.AttributeType.STRING),replication_regions=["us-east-1","us-east-2","us-west-2"],billing_mode=dynamodb.BillingMode.PROVISIONED)global_table.auto_scale_write_capacity(min_capacity=1,max_capacity=10).scale_on_utilization(target_utilization_percent=75)When adding a replica region for a large table, you might want to increase the
timeout for the replication operation:global_table=dynamodb.Table(self,"Table",partition_key=dynamodb.Attribute(name="id",type=dynamodb.AttributeType.STRING),replication_regions=["us-east-1","us-east-2","us-west-2"],replication_timeout=Duration.hours(2))EncryptionAll 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=dynamodb.Table(self,"MyTable",partition_key=dynamodb.Attribute(name="id",type=dynamodb.AttributeType.STRING),encryption=dynamodb.TableEncryption.CUSTOMER_MANAGED)# You can access the CMK that was added to the stack on your behalf by the Table construct via:table_encryption_key=table.encryption_keyYou can also supply your own key:importaws_cdk.aws_kmsaskmsencryption_key=kms.Key(self,"Key",enable_key_rotation=True)table=dynamodb.Table(self,"MyTable",partition_key=dynamodb.Attribute(name="id",type=dynamodb.AttributeType.STRING),encryption=dynamodb.TableEncryption.CUSTOMER_MANAGED,encryption_key=encryption_key)In order to use the AWS managed CMK instead, change the code to:table=dynamodb.Table(self,"MyTable",partition_key=dynamodb.Attribute(name="id",type=dynamodb.AttributeType.STRING),encryption=dynamodb.TableEncryption.AWS_MANAGED)Get schema of table or secondary indexesTo get the partition key and sort key of the table or indexes you have configured:# table: dynamodb.Tableschema=table.schema()partition_key=schema.partition_keysort_key=schema.sort_keyKinesis StreamA Kinesis Data Stream can be configured on the DynamoDB table to capture item-level changes.importaws_cdk.aws_kinesisaskinesisstream=kinesis.Stream(self,"Stream")table=dynamodb.Table(self,"Table",partition_key=dynamodb.Attribute(name="id",type=dynamodb.AttributeType.STRING),kinesis_stream=stream)