Provides a DynamoDB table.
import { Table } from 'aws-cdk-lib/aws-dynamodb';Or use the module namespace:
import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
// dynamodb.TableConfiguration passed to the constructor as TableProps.
kinesisPrecisionTimestampOptionalApproximateCreationDateTimePrecisionKinesis Data Stream approximate creation timestamp precision.
Default: ApproximateCreationDateTimePrecision.MICROSECOND
kinesisStreamOptionalIStreamKinesis Data Stream to capture item-level changes for the table.
Default: - no Kinesis Data Stream
tableNameOptionalstringEnforces a particular physical table name.
Default: <generated>
TableOptionsbillingModeOptionalinherited from TableOptionsBillingModeSpecify 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
contributorInsightsEnabledOptionalDeprecatedinherited from TableOptionsbooleanWhether CloudWatch contributor insights is enabled.
Default: false
Deprecated: use `contributorInsightsSpecification instead
contributorInsightsSpecificationOptionalinherited from TableOptionsContributorInsightsSpecificationWhether CloudWatch contributor insights is enabled and what mode is selected.
Default: - contributor insights is not enabled
deletionProtectionOptionalinherited from TableOptionsbooleanEnables deletion protection for the table.
Default: false
encryptionOptionalinherited from TableOptionsTableEncryptionWhether server-side encryption with an AWS managed customer master key is enabled. 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`.
Default: - The table is encrypted with an encryption key managed by DynamoDB, and you are not charged any fee for using it.
encryptionKeyOptionalinherited from TableOptionsIKeyExternal KMS key to use for table encryption. This property can only be set if `encryption` is set to `TableEncryption.CUSTOMER_MANAGED`.
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.
importSourceOptionalinherited from TableOptionsImportSourceSpecificationThe properties of data being imported from the S3 bucket source to the table.
Default: - no data import from the S3 bucket
maxReadRequestUnitsOptionalinherited from TableOptionsnumberThe maximum read request units for the table. 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.
Default: - on-demand throughput is disabled
maxWriteRequestUnitsOptionalinherited from TableOptionsnumberThe write request units for the table. 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.
Default: - on-demand throughput is disabled
pointInTimeRecoveryOptionalDeprecatedinherited from TableOptionsbooleanWhether point-in-time recovery is enabled.
Default: false - point in time recovery is not enabled.
Deprecated: use `pointInTimeRecoverySpecification` instead
pointInTimeRecoverySpecificationOptionalinherited from TableOptionsPointInTimeRecoverySpecificationWhether point-in-time recovery is enabled and recoveryPeriodInDays is set.
Default: - point in time recovery is not enabled.
readCapacityOptionalinherited from TableOptionsnumberThe 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.
Default: 5
removalPolicyOptionalinherited from TableOptionsRemovalPolicyThe removal policy to apply to the DynamoDB Table.
Default: RemovalPolicy.RETAIN
replicaRemovalPolicyOptionalinherited from TableOptionsRemovalPolicyThe removal policy to apply to the DynamoDB replica tables.
Default: undefined - use DynamoDB Table's removal policy
replicationRegionsOptionalinherited from TableOptionsstring[]Regions where replica tables will be created.
Default: - no replica tables are created
replicationTimeoutOptionalinherited from TableOptionsDurationThe timeout for a table replication operation in a single region.
Default: Duration.minutes(30)
resourcePolicyOptionalinherited from TableOptionsPolicyDocumentResource policy to assign to table.
Default: - No resource policy statement
streamOptionalinherited from TableOptionsStreamViewTypeWhen 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
tableClassOptionalinherited from TableOptionsTableClassSpecify the table class.
Default: STANDARD
timeToLiveAttributeOptionalinherited from TableOptionsstringThe name of TTL attribute.
Default: - TTL is disabled
waitForReplicationToFinishOptionalinherited from TableOptionsboolean[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. 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.
Default: true
warmThroughputOptionalinherited from TableOptionsWarmThroughputSpecify values to pre-warm you DynamoDB Table Warm Throughput feature is not available for Global Table replicas using the `Table` construct. To enable Warm Throughput, use the `TableV2` construct instead.
Default: - warm throughput is not configured
writeCapacityOptionalinherited from TableOptionsnumberThe 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.
Default: 5
SchemaOptionspartitionKeyOptionalinherited from SchemaOptionsAttributePartition key attribute definition. 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).
Default: - exactly one of `partitionKey` and `partitionKeys` must be specified.
sortKeyOptionalinherited from SchemaOptionsAttributeSort key attribute definition. 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).
Default: - no sort key
Everything you need to know about Amazon DynamoDB on one page. HD quality, print-friendly.
Download Free Infographicaws-dynamodb