You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DynamoDB::Types::StreamSpecification

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing StreamSpecification as input to an Aws::Client method, you can use a vanilla Hash:

{
  stream_enabled: false,
  stream_view_type: "NEW_IMAGE", # accepts NEW_IMAGE, OLD_IMAGE, NEW_AND_OLD_IMAGES, KEYS_ONLY
}

Represents the DynamoDB Streams configuration for a table in DynamoDB.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#stream_enabledBoolean

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

Returns:

  • (Boolean)

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

#stream_view_typeString

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.

    Possible values:

    • NEW_IMAGE
    • OLD_IMAGE
    • NEW_AND_OLD_IMAGES
    • KEYS_ONLY

Returns:

  • (String)

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