aws-cdk-lib.aws_dynamodb.CfnGlobalTable.StreamSpecificationProperty

interface StreamSpecificationProperty

LanguageType name
.NETAmazon.CDK.AWS.DynamoDB.CfnGlobalTable.StreamSpecificationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsdynamodb#CfnGlobalTable_StreamSpecificationProperty
Javasoftware.amazon.awscdk.services.dynamodb.CfnGlobalTable.StreamSpecificationProperty
Pythonaws_cdk.aws_dynamodb.CfnGlobalTable.StreamSpecificationProperty
TypeScript aws-cdk-lib » aws_dynamodb » CfnGlobalTable » StreamSpecificationProperty

Represents the DynamoDB Streams configuration for a table in DynamoDB.

You can only modify this value if your AWS::DynamoDB::GlobalTable contains only one entry in Replicas . You must specify a value for this property if your AWS::DynamoDB::GlobalTable contains more than one replica.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dynamodb as dynamodb } from 'aws-cdk-lib';
const streamSpecificationProperty: dynamodb.CfnGlobalTable.StreamSpecificationProperty = {
  streamViewType: 'streamViewType',
};

Properties

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

streamViewType

Type: string

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.