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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-dynamodb/types.rb

Overview

Note:

When making an API call, you may pass StreamSpecification data as a hash:

{
  stream_enabled: false, # required
  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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#stream_enabledBoolean

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

Returns:

  • (Boolean)

8586
8587
8588
8589
8590
8591
# File 'lib/aws-sdk-dynamodb/types.rb', line 8586

class StreamSpecification < Struct.new(
  :stream_enabled,
  :stream_view_type)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String)

8586
8587
8588
8589
8590
8591
# File 'lib/aws-sdk-dynamodb/types.rb', line 8586

class StreamSpecification < Struct.new(
  :stream_enabled,
  :stream_view_type)
  SENSITIVE = []
  include Aws::Structure
end