Package software.amazon.awscdk.cfnpropertymixins.services.dynamodb

Class CfnTablePropsMixin.StreamSpecificationProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.dynamodb.CfnTablePropsMixin.StreamSpecificationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTablePropsMixin.StreamSpecificationProperty>

Enclosing interface:

CfnTablePropsMixin.StreamSpecificationProperty

@Stability(Stable)
public static final class CfnTablePropsMixin.StreamSpecificationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnTablePropsMixin.StreamSpecificationProperty>

A builder for CfnTablePropsMixin.StreamSpecificationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnTablePropsMixin.StreamSpecificationProperty	build()	Builds the configured instance.
CfnTablePropsMixin.StreamSpecificationProperty.Builder	resourcePolicy(CfnTablePropsMixin.ResourcePolicyProperty resourcePolicy)	Sets the value of CfnTablePropsMixin.StreamSpecificationProperty.getResourcePolicy()
CfnTablePropsMixin.StreamSpecificationProperty.Builder	resourcePolicy(IResolvable resourcePolicy)	Sets the value of CfnTablePropsMixin.StreamSpecificationProperty.getResourcePolicy()
CfnTablePropsMixin.StreamSpecificationProperty.Builder	streamViewType(String streamViewType)	Sets the value of CfnTablePropsMixin.StreamSpecificationProperty.getStreamViewType()
CfnTablePropsMixin.StreamSpecificationProperty.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnTablePropsMixin.StreamSpecificationProperty.getTags()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

resourcePolicy

@Stability(Stable)
public CfnTablePropsMixin.StreamSpecificationProperty.Builder resourcePolicy(IResolvable resourcePolicy)

Sets the value of CfnTablePropsMixin.StreamSpecificationProperty.getResourcePolicy()

Parameters:

resourcePolicy - 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 .

Returns:

this

resourcePolicy

@Stability(Stable)
public CfnTablePropsMixin.StreamSpecificationProperty.Builder resourcePolicy(CfnTablePropsMixin.ResourcePolicyProperty resourcePolicy)

Sets the value of CfnTablePropsMixin.StreamSpecificationProperty.getResourcePolicy()

Parameters:

resourcePolicy - 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 .

Returns:

this

streamViewType

@Stability(Stable)
public CfnTablePropsMixin.StreamSpecificationProperty.Builder streamViewType(String streamViewType)

Sets the value of CfnTablePropsMixin.StreamSpecificationProperty.getStreamViewType()

Parameters:

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.

Returns:

this

tags

@Stability(Stable)
public CfnTablePropsMixin.StreamSpecificationProperty.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnTablePropsMixin.StreamSpecificationProperty.getTags()

Parameters:

tags - the value to be set.

Returns:

this

build

@Stability(Stable)
public CfnTablePropsMixin.StreamSpecificationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnTablePropsMixin.StreamSpecificationProperty>

Returns:

a new instance of CfnTablePropsMixin.StreamSpecificationProperty

Throws:

NullPointerException - if any required attribute was not provided