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 cdk from 'aws-cdk-lib';
import * as kinesis from 'aws-cdk-lib/aws-kinesis';
const app = new cdk.App();
const stack = new cdk.Stack(app, 'Stack', { env: { region: 'us-west-2' } });
const globalTable = new dynamodb.TableV2(this, 'GlobalTable', {
partitionKey: { name: 'id', type: dynamodb.AttributeType.STRING },
dynamoStream: dynamodb.StreamViewType.OLD_IMAGE,
// tables in us-west-2, us-east-1, and us-east-2 all have dynamo stream type of OLD_IMAGES
replicas: [
{ region: 'us-east-1' },
{ region: 'us-east-2' },
],
});
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.