AWS CDK Reference

Appearance

v2.274.0

TableProps Struct ​

Properties for a DynamoDB Table.

Source
aws-dynamodb/lib/table.ts
Type last changed
v2.173.0 · 12 Dec 2024

Example ​

ts
import * as eventsources from 'aws-cdk-lib/aws-lambda-event-sources';
import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
import { Key } from 'aws-cdk-lib/aws-kms';

declare const fn: lambda.Function;
const table = new dynamodb.Table(this, 'Table', {
  partitionKey: {
    name: 'id',
    type: dynamodb.AttributeType.STRING,
  },
  stream: dynamodb.StreamViewType.NEW_IMAGE,
});
// Your self managed KMS key
const myKey = Key.fromKeyArn(
  this,
  'SourceBucketEncryptionKey',
  'arn:aws:kms:us-east-1:123456789012:key/<key-id>',
);

fn.addEventSource(new eventsources.DynamoEventSource(table, {
  startingPosition: lambda.StartingPosition.LATEST,
  filters: [lambda.FilterCriteria.filter({ eventName: lambda.FilterRule.isEqual('INSERT') })],
  filterEncryption: myKey,
}));

Properties ​

billingModeBillingModebilling_modeBillingModebillingModeBillingModeBillingModeBillingModeBillingModeBillingMode#
Specify how you are charged for read and write throughput and how you manage capacity.

Default: PROVISIONED if replicationRegions is not specified, PAY_PER_REQUEST otherwise

contributorInsightsEnabledbooleancontributor_insights_enabledboolcontributorInsightsEnabledBooleanContributorInsightsEnabledboolContributorInsightsEnabled*bool= falsedeprecated#
use `contributorInsightsSpecification instead
contributorInsightsSpecificationContributorInsightsSpecificationcontributor_insights_specificationContributorInsightsSpecificationcontributorInsightsSpecificationContributorInsightsSpecificationContributorInsightsSpecificationContributorInsightsSpecificationContributorInsightsSpecificationContributorInsightsSpecification#
Whether CloudWatch contributor insights is enabled and what mode is selected.

Default: contributor insights is not enabled

deletionProtectionbooleandeletion_protectionbooldeletionProtectionBooleanDeletionProtectionboolDeletionProtection*bool= false#
Enables deletion protection for the table.
encryptionTableEncryptionencryptionTableEncryptionencryptionTableEncryptionEncryptionTableEncryptionEncryptionTableEncryption#
Whether server-side encryption with an AWS managed customer master key is enabled.

Default: The table is encrypted with an encryption key managed by DynamoDB, and you are not charged any fee for using it.

notes

This property cannot be set if serverSideEncryption is set.

NOTE: if you set this to CUSTOMER_MANAGED and encryptionKey is not specified, the key that the Tablet generates for you will be created with default permissions. If you are using CDKv2, these permissions will be sufficient to enable the key for use with DynamoDB tables. If you are using CDKv1, make sure the feature flag @aws-cdk/aws-kms:defaultKeyPolicies is set to true in your cdk.json.

encryptionKeyIKeyencryption_keyIKeyencryptionKeyIKeyEncryptionKeyIKeyEncryptionKeyIKey#
External KMS key to use for table encryption.

Default: If encryption is set to TableEncryption.CUSTOMER_MANAGED and this property is undefined, a new KMS key will be created and associated with this table. If encryption and this property are both undefined, then the table is encrypted with an encryption key managed by DynamoDB, and you are not charged any fee for using it.

This property can only be set if encryption is set to TableEncryption.CUSTOMER_MANAGED.

importSourceImportSourceSpecificationimport_sourceImportSourceSpecificationimportSourceImportSourceSpecificationImportSourceImportSourceSpecificationImportSourceImportSourceSpecification#
The properties of data being imported from the S3 bucket source to the table.

Default: no data import from the S3 bucket

kinesisPrecisionTimestampApproximateCreationDateTimePrecisionkinesis_precision_timestampApproximateCreationDateTimePrecisionkinesisPrecisionTimestampApproximateCreationDateTimePrecisionKinesisPrecisionTimestampApproximateCreationDateTimePrecisionKinesisPrecisionTimestampApproximateCreationDateTimePrecision#
Kinesis Data Stream approximate creation timestamp precision.

Default: ApproximateCreationDateTimePrecision.MICROSECOND

kinesisStreamIStreamkinesis_streamIStreamkinesisStreamIStreamKinesisStreamIStreamKinesisStreamIStream#
Kinesis Data Stream to capture item-level changes for the table.

Default: no Kinesis Data Stream

maxReadRequestUnitsnumbermax_read_request_unitsint | floatmaxReadRequestUnitsNumberMaxReadRequestUnitsdoubleMaxReadRequestUnits*float64#
The maximum read request units for the table.

Default: on-demand throughput is disabled

Careful if you add Global Secondary Indexes, as those will share the table's maximum on-demand throughput.

Can only be provided if billingMode is PAY_PER_REQUEST.

maxWriteRequestUnitsnumbermax_write_request_unitsint | floatmaxWriteRequestUnitsNumberMaxWriteRequestUnitsdoubleMaxWriteRequestUnits*float64#
The write request units for the table.

Default: on-demand throughput is disabled

Careful if you add Global Secondary Indexes, as those will share the table's maximum on-demand throughput.

Can only be provided if billingMode is PAY_PER_REQUEST.

partitionKeyAttributepartition_keyAttributepartitionKeyAttributePartitionKeyAttributePartitionKeyAttribute#
Partition key attribute definition.

Default: exactly one of partitionKey and partitionKeys must be specified.

If a single field forms the partition key, you can use this field. Use the partitionKeys field if the partition key is a multi-attribute key (consists of multiple fields).

pointInTimeRecoverybooleanpoint_in_time_recoveryboolpointInTimeRecoveryBooleanPointInTimeRecoveryboolPointInTimeRecovery*booldeprecated#
use `pointInTimeRecoverySpecification` instead

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

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

Default: point in time recovery is not enabled.

readCapacitynumberread_capacityint | floatreadCapacityNumberReadCapacitydoubleReadCapacity*float64= 5#
The read capacity for the table.

Careful if you add Global Secondary Indexes, as those will share the table's provisioned throughput.

Can only be provided if billingMode is Provisioned.

removalPolicyRemovalPolicyremoval_policyRemovalPolicyremovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicy= RemovalPolicy.RETAIN#
The removal policy to apply to the DynamoDB Table.
replicaRemovalPolicyRemovalPolicyreplica_removal_policyRemovalPolicyreplicaRemovalPolicyRemovalPolicyReplicaRemovalPolicyRemovalPolicyReplicaRemovalPolicyRemovalPolicy#
The removal policy to apply to the DynamoDB replica tables.

Default: undefined - use DynamoDB Table's removal policy

replicationRegionsstring[]replication_regionstyping.List[str]replicationRegionsList<String>ReplicationRegionsstring[]ReplicationRegions*[]*string#
Regions where replica tables will be created.

Default: no replica tables are created

replicationTimeoutDurationreplication_timeoutDurationreplicationTimeoutDurationReplicationTimeoutDurationReplicationTimeoutDuration= Duration.minutes(30)#
The timeout for a table replication operation in a single region.
resourcePolicyPolicyDocumentresource_policyPolicyDocumentresourcePolicyPolicyDocumentResourcePolicyPolicyDocumentResourcePolicyPolicyDocument#
Resource policy to assign to table.

Default: No resource policy statement

sortKeyAttributesort_keyAttributesortKeyAttributeSortKeyAttributeSortKeyAttribute#
Sort key attribute definition.

Default: no sort key

If a single field forms the sort key, you can use this field. Use the sortKeys field if the sort key is a multi-attribute key (consists of multiple fields).

streamStreamViewTypestreamStreamViewTypestreamStreamViewTypeStreamStreamViewTypeStreamStreamViewType#
When an item in the table is modified, StreamViewType determines what information is written to the stream for this table.

Default: streams are disabled unless replicationRegions is specified

tableClassTableClasstable_classTableClasstableClassTableClassTableClassTableClassTableClassTableClass= STANDARD#
Specify the table class.
tableNamestringtable_namestrtableNameStringTableNamestringTableName*string= <generated>#
Enforces a particular physical table name.
timeToLiveAttributestringtime_to_live_attributestrtimeToLiveAttributeStringTimeToLiveAttributestringTimeToLiveAttribute*string#
The name of TTL attribute.

Default: TTL is disabled

waitForReplicationToFinishbooleanwait_for_replication_to_finishboolwaitForReplicationToFinishBooleanWaitForReplicationToFinishboolWaitForReplicationToFinish*bool= true#
[WARNING: Use this flag with caution, misusing this flag may cause deleting existing replicas, refer to the detailed documentation for more information] Indicates whether CloudFormation stack waits for replication to finish.
notes

If set to false, the CloudFormation resource will mark the resource as created and replication will be completed asynchronously. This property is ignored if replicationRegions property is not set.

WARNING: DO NOT UNSET this property if adding/removing multiple replicationRegions in one deployment, as CloudFormation only supports one region replication at a time. CDK overcomes this limitation by waiting for replication to finish before starting new replicationRegion.

If the custom resource which handles replication has a physical resource ID with the format region instead of tablename-region (this would happen if the custom resource hasn't received an event since v1.91.0), DO NOT SET this property to false without making a change to the table name. This will cause the existing replicas to be deleted.

warmThroughputWarmThroughputwarm_throughputWarmThroughputwarmThroughputWarmThroughputWarmThroughputWarmThroughputWarmThroughputWarmThroughput#
Specify values to pre-warm you DynamoDB Table Warm Throughput feature is not available for Global Table replicas using the `Table` construct.

Default: warm throughput is not configured

To enable Warm Throughput, use the TableV2 construct instead.

writeCapacitynumberwrite_capacityint | floatwriteCapacityNumberWriteCapacitydoubleWriteCapacity*float64= 5#
The write capacity for the table.

Careful if you add Global Secondary Indexes, as those will share the table's provisioned throughput.

Can only be provided if billingMode is Provisioned.