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.106.0 (build e852934)",
date="2025-02-06T22:15:52.784Z")
@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) .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 ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forTableOptionsV2
static final class
An implementation forTableOptionsV2
-
Method Summary
Modifier and TypeMethodDescriptionstatic TableOptionsV2.Builder
builder()
default Boolean
Whether CloudWatch contributor insights is enabled.default Boolean
Whether deletion protection is enabled.default IStream
Kinesis Data Stream to capture item level changes.default Boolean
Deprecated.default PointInTimeRecoverySpecification
Whether point-in-time recovery is enabled and recoveryPeriodInDays is set.default PolicyDocument
Resource policy to assign to DynamoDB Table.default TableClass
The table class.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
Whether CloudWatch contributor insights is enabled.Default: false
-
getDeletionProtection
Whether deletion protection is enabled.Default: false
-
getKinesisStream
Kinesis Data Stream to capture item level changes.Default: - no Kinesis Data Stream
-
getPointInTimeRecovery
Deprecated.usepointInTimeRecoverySpecification
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
Resource policy to assign to DynamoDB Table.Default: - No resource policy statements are added to the created table.
- See Also:
-
getTableClass
The table class.Default: TableClass.STANDARD
-
getTags
Tags to be applied to the primary table (default replica table).Default: - no tags
-
builder
- Returns:
- a
TableOptionsV2.Builder
ofTableOptionsV2
-
pointInTimeRecoverySpecification
instead