Package software.amazon.awscdk.services.dynamodb

Interface CfnTable.StreamSpecificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTable.StreamSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnTable

@Stability(Stable)
public static interface CfnTable.StreamSpecificationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.dynamodb.*;
 Object policyDocument;
 StreamSpecificationProperty streamSpecificationProperty = StreamSpecificationProperty.builder()
         .streamViewType("streamViewType")
         // the properties below are optional
         .resourcePolicy(ResourcePolicyProperty.builder()
                 .policyDocument(policyDocument)
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-streamspecification.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTable.StreamSpecificationProperty.Builder	A builder for CfnTable.StreamSpecificationProperty
static final class	CfnTable.StreamSpecificationProperty.Jsii$Proxy	An implementation for CfnTable.StreamSpecificationProperty

Method Summary

Modifier and Type	Method	Description
static CfnTable.StreamSpecificationProperty.Builder	builder()
default Object	getResourcePolicy()	Creates or updates a resource-based policy document that contains the permissions for DynamoDB resources, such as a table's streams.
String	getStreamViewType()	When an item in the table is modified, StreamViewType determines what information is written to the stream for this table.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getStreamViewType

@Stability(Stable)
@NotNull
String getStreamViewType()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-streamspecification.html#cfn-dynamodb-table-streamspecification-streamviewtype

getResourcePolicy

@Stability(Stable)
@Nullable
default Object getResourcePolicy()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-streamspecification.html#cfn-dynamodb-table-streamspecification-resourcepolicy

builder

@Stability(Stable)
static CfnTable.StreamSpecificationProperty.Builder builder()

Returns:

a CfnTable.StreamSpecificationProperty.Builder of CfnTable.StreamSpecificationProperty