Class DynamoTable

A construct that simplifies the creation and configuration of a DynamoDB table with Lambda integration.

The DynamoTable construct creates a DynamoDB table with sensible defaults and automatically grants the necessary permissions to specified Lambda functions to read from and/or write to the table.

This construct is ideal for projects where you need to quickly set up a DynamoDB table that your Lambda functions can interact with, without having to manually configure IAM permissions.

Example

import { Stack, RemovalPolicy } from 'aws-cdk-lib';
import { lambda, dynamodb } from '@reuters-graphics/structs';
import { Construct } from 'constructs';
import * as dynamodbLib from 'aws-cdk-lib/aws-dynamodb';

export class MyDynamoStack extends Stack {
  constructor(scope: Construct, id: string) {
    super(scope, id);

    // Create a Lambda function
    const myLambda = new lambda.NodeJsLambda(this, 'my-lambda', {
      entry: './src/index.ts',
      handler: 'handle',
    });

    // Create a DynamoDB table with Lambda write permissions
    const myTable = new dynamodb.DynamoTable(this, 'my-table', {
      partitionKey: {
        name: 'id',
        type: dynamodbLib.AttributeType.STRING
      },
      sortKey: {
        name: 'timestamp',
        type: dynamodbLib.AttributeType.NUMBER
      },
      writeLambdas: [myLambda.lambda],
      pointInTimeRecovery: true,
      removalPolicy: RemovalPolicy.DESTROY,
    });

    // Access the underlying DynamoDB table
    const table = myTable.table;

    // Add environment variable to Lambda with table name
    myLambda.lambda.addEnvironment('TABLE_NAME', myTable.table.tableName);
  }
}
Copy