@aws-cdk/aws-dynamodb
    TypeScript icon, indicating that this package has built-in type declarations

    1.139.0 • Public • Published

    Amazon DynamoDB Construct Library


    cfn-resources: Stable

    cdk-constructs: Stable


    Here is a minimal deployable DynamoDB table definition:

    const table = new dynamodb.Table(this, 'Table', {
      partitionKey: { name: 'id', type: dynamodb.AttributeType.STRING },
    });

    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:

    declare const user: iam.User;
    const table = dynamodb.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.
    const table = new dynamodb.Table(this, 'Table', {
      partitionKey: { name: 'id', type: dynamodb.AttributeType.STRING },
      billingMode: dynamodb.BillingMode.PAY_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:

    const globalTable = new dynamodb.Table(this, 'Table', {
      partitionKey: { name: 'id', type: dynamodb.AttributeType.STRING },
      replicationRegions: ['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:

    const globalTable = new dynamodb.Table(this, 'Table', {
      partitionKey: { name: 'id', type: dynamodb.AttributeType.STRING },
      replicationRegions: ['us-east-1', 'us-east-2', 'us-west-2'],
      billingMode: dynamodb.BillingMode.PROVISIONED,
    });
    
    globalTable.autoScaleWriteCapacity({
      minCapacity: 1,
      maxCapacity: 10,
    }).scaleOnUtilization({ targetUtilizationPercent: 75 });

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

    const globalTable = new dynamodb.Table(this, 'Table', {
      partitionKey: { name: 'id', type: dynamodb.AttributeType.STRING },
      replicationRegions: ['us-east-1', 'us-east-2', 'us-west-2'],
      replicationTimeout: Duration.hours(2), // defaults to Duration.minutes(30)
    });

    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:

    const table = new dynamodb.Table(this, 'MyTable', {
      partitionKey: { 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:
    const tableEncryptionKey = table.encryptionKey;

    You can also supply your own key:

    import * as kms from '@aws-cdk/aws-kms';
    
    const encryptionKey = new kms.Key(this, 'Key', {
      enableKeyRotation: true,
    });
    const table = new dynamodb.Table(this, 'MyTable', {
      partitionKey: { name: 'id', type: dynamodb.AttributeType.STRING },
      encryption: dynamodb.TableEncryption.CUSTOMER_MANAGED,
      encryptionKey, // This will be exposed as table.encryptionKey
    });

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

    const table = new dynamodb.Table(this, 'MyTable', {
      partitionKey: { name: 'id', type: dynamodb.AttributeType.STRING },
      encryption: dynamodb.TableEncryption.AWS_MANAGED,
    });
    
    // In this case, the CMK _cannot_ be accessed through table.encryptionKey.

    Get schema of table or secondary indexes

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

    declare const table: dynamodb.Table;
    const schema = table.schema();
    const partitionKey = schema.partitionKey;
    const sortKey = schema.sortKey;
    
    // In case you want to get schema details for any secondary index
    // const { partitionKey, sortKey } = table.schema(INDEX_NAME);

    Kinesis Stream

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

    import * as kinesis from '@aws-cdk/aws-kinesis';
    
    const stream = new kinesis.Stream(this, 'Stream');
    
    const table = new dynamodb.Table(this, 'Table', {
      partitionKey: { name: 'id', type: dynamodb.AttributeType.STRING },
      kinesisStream: stream,
    });

    Install

    npm i @aws-cdk/aws-dynamodb

    DownloadsWeekly Downloads

    1,644,122

    Version

    1.139.0

    License

    Apache-2.0

    Unpacked Size

    1.66 MB

    Total Files

    27

    Last publish

    Collaborators

    • eladb
    • romainmuller
    • amzn-oss
    • rix0rrr
    • aws-cdk-team