interface StreamSpecificationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.DynamoDB.CfnTable.StreamSpecificationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsdynamodb#CfnTable_StreamSpecificationProperty`
Java	`software.amazon.awscdk.services.dynamodb.CfnTable.StreamSpecificationProperty`
Python	`aws_cdk.aws_dynamodb.CfnTable.StreamSpecificationProperty`
TypeScript	`aws-cdk-lib` » `aws_dynamodb` » `CfnTable` » `StreamSpecificationProperty`

Represents the DynamoDB Streams configuration for a table in DynamoDB.

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';

declare const policyDocument: any;
const streamSpecificationProperty: dynamodb.CfnTable.StreamSpecificationProperty = {
  streamViewType: 'streamViewType',

  // the properties below are optional
  resourcePolicy: {
    policyDocument: policyDocument,
  },
};

Properties

Name	Type	Description
streamViewType	`string`	When an item in the table is modified, `StreamViewType` determines what information is written to the stream for this table.
resourcePolicy?	`IResolvable` `\|` `ResourcePolicyProperty`	Creates or updates a resource-based policy document that contains the permissions for DynamoDB resources, such as a table's streams.

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.

resourcePolicy?

Type: IResolvable | ResourcePolicyProperty (optional)

Creates or updates a resource-based policy document that contains the permissions for DynamoDB resources, such as a table's streams.

Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource.

When you remove the StreamSpecification property from the template, DynamoDB disables the stream but retains any attached resource policy until the stream is deleted after 24 hours. When you modify the StreamViewType property, DynamoDB creates a new stream and retains the old stream's resource policy. The old stream and its resource policy are deleted after the 24-hour retention period.

In a CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .