Skip to content

CdcSpecification

Source code in docs_src/capo_keyspaces/types/cdc_specification.py
class CdcSpecification(TypedDict, closed=True):
    status: "capo_keyspaces.types.cdc_status.CdcStatus"
    """<p>The status of the CDC stream. You can enable or disable a stream for a table.</p>"""
    view_type: NotRequired["capo_keyspaces.types.view_type.ViewType"]
    """<p>The view type specifies the changes Amazon Keyspaces records for each changed row in the stream. After you create the stream, you can't make changes to this selection. </p> <p>The options are:</p> <ul> <li> <p> <code>NEW_AND_OLD_IMAGES</code> - both versions of the row, before and after the change. This is the default.</p> </li> <li> <p> <code>NEW_IMAGE</code> - the version of the row after the change.</p> </li> <li> <p> <code>OLD_IMAGE</code> - the version of the row before the change.</p> </li> <li> <p> <code>KEYS_ONLY</code> - the partition and clustering keys of the row that was changed.</p> </li> </ul>"""
    tags: NotRequired["capo_keyspaces.types.tag_list.TagList"]
    """<p>The tags (key-value pairs) that you want to apply to the stream.</p>"""
    propagate_tags: NotRequired[
        "capo_keyspaces.types.cdc_propagate_tags.CdcPropagateTags"
    ]
    """<p>Specifies that the stream inherits the tags from the table.</p>"""

propagate_tags instance-attribute

propagate_tags: NotRequired[CdcPropagateTags]

Specifies that the stream inherits the tags from the table.

status instance-attribute

status: CdcStatus

The status of the CDC stream. You can enable or disable a stream for a table.

tags instance-attribute

tags: NotRequired[TagList]

The tags (key-value pairs) that you want to apply to the stream.

view_type instance-attribute

view_type: NotRequired[ViewType]

The view type specifies the changes Amazon Keyspaces records for each changed row in the stream. After you create the stream, you can't make changes to this selection.

The options are:

  • NEW_AND_OLD_IMAGES - both versions of the row, before and after the change. This is the default.

  • NEW_IMAGE - the version of the row after the change.

  • OLD_IMAGE - the version of the row before the change.

  • KEYS_ONLY - the partition and clustering keys of the row that was changed.