Skip to content

StreamSpecification

Used by
Source code in docs_src/capo_dynamodb/types/stream_specification.py 
14
15
16
17
18
class StreamSpecification(TypedDict, closed=True):
    stream_enabled: "capo_dynamodb.types.stream_enabled.StreamEnabled"
    """<p>Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.</p>"""
    stream_view_type: NotRequired["capo_dynamodb.types.stream_view_type.StreamViewType"]
    """<p> When an item in the table is modified, <code>StreamViewType</code> determines what information is written to the stream for this table. Valid values for <code>StreamViewType</code> are:</p> <ul> <li> <p> <code>KEYS_ONLY</code> - Only the key attributes of the modified item are written to the stream.</p> </li> <li> <p> <code>NEW_IMAGE</code> - The entire item, as it appears after it was modified, is written to the stream.</p> </li> <li> <p> <code>OLD_IMAGE</code> - The entire item, as it appeared before it was modified, is written to the stream.</p> </li> <li> <p> <code>NEW_AND_OLD_IMAGES</code> - Both the new and the old item images of the item are written to the stream.</p> </li> </ul>"""

stream_enabled instance-attribute 

stream_enabled: StreamEnabled

Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

stream_view_type instance-attribute 

stream_view_type: NotRequired[StreamViewType]

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

  • 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.