TableOptionsV2 Struct
Options used to configure a DynamoDB table.
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';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_kinesis as kinesis } from 'aws-cdk-lib';
declare const policyDocument: iam.PolicyDocument;
declare const stream: kinesis.Stream;
const tableOptionsV2: dynamodb.TableOptionsV2 = {
contributorInsights: false,
contributorInsightsSpecification: {
enabled: false,
// the properties below are optional
mode: dynamodb.ContributorInsightsMode.ACCESSED_AND_THROTTLED_KEYS,
},
deletionProtection: false,
kinesisStream: stream,
pointInTimeRecovery: false,
pointInTimeRecoverySpecification: {
pointInTimeRecoveryEnabled: false,
// the properties below are optional
recoveryPeriodInDays: 123,
},
resourcePolicy: policyDocument,
streamResourcePolicy: policyDocument,
tableClass: dynamodb.TableClass.STANDARD,
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
contributorInsightsoptionalbooleancontributor_insightsoptionalboolcontributorInsightsoptionalBooleanContributorInsightsoptionalboolContributorInsightsoptional*bool= falsedeprecated#use `contributorInsightsSpecification` instead
contributorInsightsSpecificationoptionalContributorInsightsSpecificationcontributor_insights_specificationoptionalContributorInsightsSpecificationcontributorInsightsSpecificationoptionalContributorInsightsSpecificationContributorInsightsSpecificationoptionalContributorInsightsSpecificationContributorInsightsSpecificationoptionalContributorInsightsSpecification#Whether CloudWatch contributor insights is enabled and what mode is selected.
Default: contributor insights is not enabled
deletionProtectionoptionalbooleandeletion_protectionoptionalbooldeletionProtectionoptionalBooleanDeletionProtectionoptionalboolDeletionProtectionoptional*bool= false#Whether deletion protection is enabled.
kinesisStreamoptionalIStreamkinesis_streamoptionalIStreamkinesisStreamoptionalIStreamKinesisStreamoptionalIStreamKinesisStreamoptionalIStream#Kinesis Data Stream to capture item level changes.
Default: no Kinesis Data Stream
pointInTimeRecoveryoptionalbooleanpoint_in_time_recoveryoptionalboolpointInTimeRecoveryoptionalBooleanPointInTimeRecoveryoptionalboolPointInTimeRecoveryoptional*booldeprecated#use `pointInTimeRecoverySpecification` instead
Default: false - point in time recovery is not enabled.
pointInTimeRecoverySpecificationoptionalPointInTimeRecoverySpecificationpoint_in_time_recovery_specificationoptionalPointInTimeRecoverySpecificationpointInTimeRecoverySpecificationoptionalPointInTimeRecoverySpecificationPointInTimeRecoverySpecificationoptionalPointInTimeRecoverySpecificationPointInTimeRecoverySpecificationoptionalPointInTimeRecoverySpecification#Whether point-in-time recovery is enabled and recoveryPeriodInDays is set.
Default: point in time recovery is not enabled.
resourcePolicyoptionalPolicyDocumentresource_policyoptionalPolicyDocumentresourcePolicyoptionalPolicyDocumentResourcePolicyoptionalPolicyDocumentResourcePolicyoptionalPolicyDocument#Resource policy to assign to DynamoDB Table.
Default: No resource policy statements are added to the created table.
streamResourcePolicyoptionalPolicyDocumentstream_resource_policyoptionalPolicyDocumentstreamResourcePolicyoptionalPolicyDocumentStreamResourcePolicyoptionalPolicyDocumentStreamResourcePolicyoptionalPolicyDocument#Resource policy to assign to DynamoDB Stream.
Default: No resource policy statements are added to the stream.
tableClassoptionalTableClasstable_classoptionalTableClasstableClassoptionalTableClassTableClassoptionalTableClassTableClassoptionalTableClass= TableClass.STANDARD#The table class.