Package software.amazon.awscdk.services.dynamodb

Interface TableOptionsV2

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ReplicaTableProps, TablePropsV2

All Known Implementing Classes:

ReplicaTableProps.Jsii$Proxy, TableOptionsV2.Jsii$Proxy, TablePropsV2.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:35.310Z")
@Stability(Stable)
public interface TableOptionsV2
extends software.amazon.jsii.JsiiSerializable

Options used to configure a DynamoDB table.

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.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.kinesis.*;
 PolicyDocument policyDocument;
 Stream stream;
 TableOptionsV2 tableOptionsV2 = TableOptionsV2.builder()
         .contributorInsights(false)
         .contributorInsightsSpecification(ContributorInsightsSpecification.builder()
                 .enabled(false)
                 // the properties below are optional
                 .mode(ContributorInsightsMode.ACCESSED_AND_THROTTLED_KEYS)
                 .build())
         .deletionProtection(false)
         .kinesisStream(stream)
         .pointInTimeRecovery(false)
         .pointInTimeRecoverySpecification(PointInTimeRecoverySpecification.builder()
                 .pointInTimeRecoveryEnabled(false)
                 // the properties below are optional
                 .recoveryPeriodInDays(123)
                 .build())
         .resourcePolicy(policyDocument)
         .tableClass(TableClass.STANDARD)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static TableOptionsV2.Builder	builder()
default Boolean	getContributorInsights()	Deprecated. use contributorInsightsSpecification instead
default ContributorInsightsSpecification	getContributorInsightsSpecification()	Whether CloudWatch contributor insights is enabled and what mode is selected.
default Boolean	getDeletionProtection()	Whether deletion protection is enabled.
default IStream	getKinesisStream()	Kinesis Data Stream to capture item level changes.
default Boolean	getPointInTimeRecovery()	Deprecated. use pointInTimeRecoverySpecification instead
default PointInTimeRecoverySpecification	getPointInTimeRecoverySpecification()	Whether point-in-time recovery is enabled and recoveryPeriodInDays is set.
default PolicyDocument	getResourcePolicy()	Resource policy to assign to DynamoDB Table.
default TableClass	getTableClass()	The table class.
default List<CfnTag>	getTags()	Tags to be applied to the primary table (default replica table).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContributorInsights

@Stability(Deprecated)
@Deprecated
@Nullable
default Boolean getContributorInsights()

Deprecated.

use contributorInsightsSpecification instead

(deprecated) Whether CloudWatch contributor insights is enabled.

Default: false

getContributorInsightsSpecification

@Stability(Stable)
@Nullable
default ContributorInsightsSpecification getContributorInsightsSpecification()

Whether CloudWatch contributor insights is enabled and what mode is selected.

Default: - contributor insights is not enabled

getDeletionProtection

@Stability(Stable)
@Nullable
default Boolean getDeletionProtection()

Whether deletion protection is enabled.

Default: false

getKinesisStream

@Stability(Stable)
@Nullable
default IStream getKinesisStream()

Kinesis Data Stream to capture item level changes.

Default: - no Kinesis Data Stream

getPointInTimeRecovery

@Stability(Deprecated)
@Deprecated
@Nullable
default Boolean getPointInTimeRecovery()

Deprecated.

use pointInTimeRecoverySpecification instead

(deprecated) Whether point-in-time recovery is enabled.

Default: false - point in time recovery is not enabled.

getPointInTimeRecoverySpecification

@Stability(Stable)
@Nullable
default PointInTimeRecoverySpecification getPointInTimeRecoverySpecification()

Whether point-in-time recovery is enabled and recoveryPeriodInDays is set.

Default: - point in time recovery is not enabled.

getResourcePolicy

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

Resource policy to assign to DynamoDB Table.

Default: - No resource policy statements are added to the created table.

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-resourcepolicy

getTableClass

@Stability(Stable)
@Nullable
default TableClass getTableClass()

The table class.

Default: TableClass.STANDARD

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Tags to be applied to the primary table (default replica table).

Default: - no tags

builder

@Stability(Stable)
static TableOptionsV2.Builder builder()

Returns:

a TableOptionsV2.Builder of TableOptionsV2