View a markdown version of this page

AWS::DynamoDB::Stream - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::DynamoDB::Stream

The AWS::DynamoDB::Stream resource Property description not available. for DynamoDB.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::DynamoDB::Stream",
  "Properties" : {
      "StreamViewType" : String,
      "TableName" : String
    }
}

YAML

Type: AWS::DynamoDB::Stream
Properties:
  StreamViewType: String
  TableName: String

Properties

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.

Required: No

Type: String

Allowed values: KEYS_ONLY | NEW_IMAGE | OLD_IMAGE | NEW_AND_OLD_IMAGES

Update requires: Replacement

TableName

Property description not available.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9_.-]+$

Minimum: 3

Maximum: 255

Update requires: Replacement

Return values

Ref

Fn::GetAtt

CreationRequestDateTime

Property description not available.

KeySchema

Property description not available.

StreamArn

The ARN for a specific Kinesis data stream.

StreamLabel

Property description not available.

StreamStatus

Property description not available.