StreamViewType

class aws_cdk.aws_dynamodb.StreamViewType(value)

Bases: Enum

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

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

Example:

import aws_cdk as cdk
import aws_cdk.aws_kinesis as kinesis


app = cdk.App()
stack = cdk.Stack(app, "Stack", env=cdk.Environment(region="us-west-2"))

global_table = dynamodb.TableV2(self, "GlobalTable",
    partition_key=dynamodb.Attribute(name="id", type=dynamodb.AttributeType.STRING),
    dynamo_stream=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=[dynamodb.ReplicaTableProps(region="us-east-1"), dynamodb.ReplicaTableProps(region="us-east-2")
    ]
)

Attributes

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

NEW_AND_OLD_IMAGES: Both the new and the old item images of the 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.