Dynamodb Table Example in AWS CDK - Complete Guide

Table of Contents #

1. Creating a Dynamodb Table in AWS CDK
2. Granting Dynamodb table Permissions in AWS CDK
3. Configuring Auto Scaling for a Dynamodb Table in AWS CDK

Creating a Dynamodb Table in AWS CDK #

In order to create a dynamodb table in AWS CDK, we have to instantiate the Table class.

Let's look at a simple example where we create a dynamodb table and add a local secondary index to it:

Copied!
import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
import * as iam from 'aws-cdk-lib/aws-iam';
import * as cdk from 'aws-cdk-lib';

export class CdkStarterStack extends cdk.Stack {
  constructor(scope: cdk.App, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    // 👇 create Dynamodb table
    const table = new dynamodb.Table(this, id, {
      billingMode: dynamodb.BillingMode.PROVISIONED,
      readCapacity: 1,
      writeCapacity: 1,
      removalPolicy: cdk.RemovalPolicy.DESTROY,
      partitionKey: {name: 'id', type: dynamodb.AttributeType.STRING},
      sortKey: {name: 'createdAt', type: dynamodb.AttributeType.NUMBER},
      pointInTimeRecovery: true,
    });

    console.log('table name 👉', table.tableName);
    console.log('table arn 👉', table.tableArn);

    // 👇 add local secondary index
    table.addLocalSecondaryIndex({
      indexName: 'statusIndex',
      sortKey: {name: 'status', type: dynamodb.AttributeType.STRING},
      projectionType: dynamodb.ProjectionType.ALL,
    });
  }
}

Let's go over what we did in the code snippet.

1. We created a dynamodb table. The configuration props we passed to the Table class are:

• billingMode - we set it as PROVISIONED. The alternative is PAY_PER_REQUEST, where the table will automatically scale with the traffic.

• readCapacity and writeCapacity - the provisioned throughput for the table

• removalPolicy - specify what should happen to the table if we delete the cdk stack or the table resource itself.

  The default removalPolicy for stateful resources (databases, S3 buckets, Cognito User Pools, etc) is RETAIN, which means that the resource will remain in an orphaned state in the account, even after the CDK stack is deleted.

• partitionKey and sortKey - the primary key for our dynamodb table

• pointInTimeRecovery - when set to true - enables continuous backups for our dynamodb table

2. We added a local secondary index to the dynamodb table. Note that we can only add local secondary indexes to a dynamodb table at table creation time

Let's issue the deployment command:

Copied!
npx aws-cdk deploy

If we take a look at the dynamodb management console, we can see that the table has been created:

Granting Dynamodb table Permissions in AWS CDK #

In order to grant permissions on a dynamodb table in CDK, we have to use the grant* methods on an instance of the Table class, for example:

• grantWriteData - permits an IAM principal to execute all write operations on a dynamodb table
• grantReadData - permits an IAM principal to execute all read operations on a dynamodb table
• grant - allows for a more fine-grained approach, where we pick which actions a principal can execute on a dynamodb table

Let's look at an example of using grantReadData:

Copied!
import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
import * as iam from 'aws-cdk-lib/aws-iam';
import * as cdk from 'aws-cdk-lib';

export class CdkStarterStack extends cdk.Stack {
  constructor(scope: cdk.App, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    // ... rest

    // 👇 grant permissions on table
    table.grantReadData(new iam.AccountRootPrincipal());
  }
}

We allowed the AWS account, into which the stack was deployed, to execute read operations on the dynamodb table.

A very common scenario is to use the grant* methods to grant permissions to a lambda function. For example, this line grants permission to a lambda to execute all read operations on the table:

Copied!
table.grantReadData(lambda);

A more fine-grained approach would be to use the grant method and specify the action:

Copied!
table.grant(lambda, ['dynamodb:Query']);

By using the grant method, we can follow the IAM best practice of granting only the permissions that are required to perform a task.

Configuring Auto Scaling for a Dynamodb Table in AWS CDK #

In order to configure auto scaling for a Dynamodb table in CDK, we have to use the autoScaleReadCapacity and autoScaleWriteCapacity methods on an instance of the Table class.

Let's look at an example where we configure auto scaling for the write capacity of our table.

Copied!
import * as appautoscaling from 'aws-cdk-lib/aws-applicationautoscaling';
import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
import * as iam from 'aws-cdk-lib/aws-iam';
import * as cdk from 'aws-cdk-lib';

export class CdkStarterStack extends cdk.Stack {
  constructor(scope: cdk.App, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    // ... rest

    // 👇 configure auto scaling on table
    const writeAutoScaling = table.autoScaleWriteCapacity({
      minCapacity: 1,
      maxCapacity: 2,
    });

    // 👇 scale up when write capacity hits 75%
    writeAutoScaling.scaleOnUtilization({
      targetUtilizationPercent: 75,
    });

    // 👇 scale up at 9 o'clock in the morning
    writeAutoScaling.scaleOnSchedule('scale-up', {
      schedule: appautoscaling.Schedule.cron({hour: '9', minute: '0'}),
      minCapacity: 2,
    });

    // 👇 scale down in the afternoon
    writeAutoScaling.scaleOnSchedule('scale-down', {
      schedule: appautoscaling.Schedule.cron({hour: '14', minute: '0'}),
      maxCapacity: 2,
    });
  }
}

In the code snippet:

1. We used the autoScaleWriteCapacity method to enable auto scaling for the write capacity of our dynamodb table
2. We used the scaleOnUtilization method to scale our dynamodb table up, in the event that the table's utilization reaches 75%.
3. We used the scaleOnSchedule method to scale our table up and down depending on the time of the day.

Let's deploy the changes:

Copied!
npx aws-cdk deploy

If we take a look at the dynamodb management console, we can see that the write capacity auto scaling configuration of the table has been updated:

Clean up #

To delete the resources we've provisioned, issue the destroy command:

Copied!
npx aws-cdk destroy

Further Reading #

• Add a Dynamodb Global Secondary Index in AWS CDK [GSI]
• API Gateway Example in AWS CDK - Complete Guide
• Lambda Function Example in AWS CDK - Complete Guide
• Write TypeScript Lambda functions in AWS CDK - Complete Guide
• AWS CDK Tutorial for Beginners - Step-by-Step Guide
• What is an identifier (id) in AWS CDK
• How to use Context in AWS CDK
• How to use Parameters in AWS CDK