enum StreamViewType

Language	Type name
.NET	Amazon.CDK.AWS.DynamoDB.StreamViewType
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsdynamodb#StreamViewType
Java	software.amazon.awscdk.services.dynamodb.StreamViewType
Python	aws_cdk.aws_dynamodb.StreamViewType
TypeScript (source)	aws-cdk-lib » aws_dynamodb » StreamViewType

When an item in the table is modified, StreamViewType determines what information is written to the stream for this table.

See also: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_StreamSpecification.html

Example

import * as eventsources from 'aws-cdk-lib/aws-lambda-event-sources';
import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';

declare const fn: lambda.Function;
const table = new dynamodb.Table(this, 'Table', {
  partitionKey: {
    name: 'id',
    type: dynamodb.AttributeType.STRING,
  },
  stream: dynamodb.StreamViewType.NEW_IMAGE,
});

fn.addEventSource(new eventsources.DynamoEventSource(table, {
  startingPosition: lambda.StartingPosition.LATEST,
  metricsConfig: {
    metrics: [lambda.MetricType.EVENT_COUNT],
  }
}));

Members

Name	Description
NEW_IMAGE	The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE	The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES	Both the new and the old item images of the item are written to the stream.
KEYS_ONLY	Only the key attributes of the modified item are written to the stream.

---

NEW_IMAGE

The entire item, as it appears after it was modified, is written to the stream.

---

OLD_IMAGE

The entire item, as it appeared before it was modified, is written to the stream.

---

NEW_AND_OLD_IMAGES

Both the new and the old item images of the item are written to the stream.

---

KEYS_ONLY

Only the key attributes of the modified item are written to the stream.