Skip to content
v2.278.0

StreamSpecificationProperty Struct ​

Represents the DynamoDB Streams configuration for a table in DynamoDB.

Example ​

ts
// 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,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_dynamodb as dynamodb

# policy_document: Any

stream_specification_property = dynamodb.CfnTable.StreamSpecificationProperty(
    stream_view_type="streamViewType",

    # the properties below are optional
    resource_policy=dynamodb.CfnTable.ResourcePolicyProperty(
        policy_document=policy_document
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.dynamodb.*;

Object policyDocument;

StreamSpecificationProperty streamSpecificationProperty = StreamSpecificationProperty.builder()
        .streamViewType("streamViewType")

        // the properties below are optional
        .resourcePolicy(ResourcePolicyProperty.builder()
                .policyDocument(policyDocument)
                .build())
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DynamoDB;

var policyDocument;

var streamSpecificationProperty = new StreamSpecificationProperty {
    StreamViewType = "streamViewType",

    // the properties below are optional
    ResourcePolicy = new ResourcePolicyProperty {
        PolicyDocument = policyDocument
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var policyDocument interface{}

streamSpecificationProperty := &StreamSpecificationProperty{
	StreamViewType: jsii.String("streamViewType"),

	// the properties below are optional
	ResourcePolicy: &ResourcePolicyProperty{
		PolicyDocument: policyDocument,
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

resourcePolicyoptionalIResolvable | CfnTable.ResourcePolicyPropertyresource_policyoptionaltyping.Union[IResolvable, ResourcePolicyProperty]resourcePolicyoptionalIResolvableResourcePolicyoptionalIResolvableResourcePolicyoptionalinterface{} #
Creates or updates a resource-based policy document that contains the permissions for DynamoDB resources, such as a table's streams.
notes

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 .

streamViewTypestringstream_view_typestrstreamViewTypeStringStreamViewTypestringStreamViewType*string required #
When an item in the table is modified, `StreamViewType` determines what information is written to the stream for this table.
notes

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.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #
Specifies the tags to apply to the DDB stream.

Stream tags are independent of table tags. For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.