# TableV2

A DynamoDB Table.

Extends: Construct › Resource › TableBaseV2 › TableV2
Implements: IResource, ITable, ITableV2, IResourceWithPolicy, IResourceWithPolicyV2, IEnvironmentAware, ITableRef, IConstruct, IDependable

- Source: [`aws-dynamodb/lib/table-v2.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-dynamodb/lib/table-v2.ts#L607)
- Type last changed: v2.254.0 · 13 May 2026

## Example

```ts
import * as cdk from 'aws-cdk-lib';

const app = new cdk.App();
const stack = new cdk.Stack(app, 'Stack', { env: { region: 'us-west-2' } });

const mrscTable = new dynamodb.TableV2(stack, 'MRSCTable', {
  partitionKey: { name: 'pk', type: dynamodb.AttributeType.STRING },
  multiRegionConsistency: dynamodb.MultiRegionConsistency.STRONG,
  replicas: [
    { region: 'us-east-1' },
  ],
  witnessRegion: 'us-east-2',
});
```

## Initializer

```ts
new TableV2(scope: Construct, id: string, props: TablePropsV2)
```

## Construct Props

- `billing`: [Billing](/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb.Billing.html) = Billing.onDemand() — The billing mode and capacity settings to apply to the table.

- `contributorInsights`: boolean = false — use `contributorInsightsSpecification` instead

- `contributorInsightsSpecification`: [ContributorInsightsSpecification](/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb.ContributorInsightsSpecification.html) — Whether CloudWatch contributor insights is enabled and what mode is selected.

  **Default:** contributor insights is not enabled

- `deletionProtection`: boolean = false — Whether deletion protection is enabled.

- `dynamoStream`: [StreamViewType](/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb.StreamViewType.html) — When an item in the table is modified, StreamViewType determines what information is written to the stream.

  **Default:** streams are disabled if replicas are not configured and this property is not specified. If this property is not specified when replicas are configured, then NEW_AND_OLD_IMAGES will be the StreamViewType for all replicas

- `encryption`: [TableEncryptionV2](/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb.TableEncryptionV2.html) — The server-side encryption.

  **Default:** TableEncryptionV2.dynamoOwnedKey()

- `globalSecondaryIndexes`: [GlobalSecondaryIndexPropsV2](/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb.GlobalSecondaryIndexPropsV2.html)[] — Global secondary indexes.

  **Default:** no global secondary indexes

  Note: You can provide a maximum of 20 global secondary indexes.

- `globalTableSettingsReplicationMode`: [GlobalTableSettingsReplicationMode](/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb.GlobalTableSettingsReplicationMode.html) — Controls whether table settings are synchronized across replicas.

  **Default:** GlobalTableSettingsReplicationMode.NONE

  When set to ALL, synchronizable settings (billing mode, throughput, TTL, streams view type, GSIs)
  are automatically replicated across all replicas. When set to NONE, each replica manages its own
  settings independently (billing mode must be PAY_PER_REQUEST).

  Note: Some settings are always synchronized (key schema, LSIs) regardless of this setting,
  and some are never synchronized (table class, SSE, deletion protection, PITR, tags, resource policy).

- `kinesisStream`: [IStream](/cdk/api/v2/docs/aws-cdk-lib.aws_kinesis.IStream.html) — Kinesis Data Stream to capture item level changes.

  **Default:** no Kinesis Data Stream

- `localSecondaryIndexes`: [LocalSecondaryIndexProps](/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb.LocalSecondaryIndexProps.html)[] — Local secondary indexes.

  **Default:** no local secondary indexes

  Note: You can only provide a maximum of 5 local secondary indexes.

- `multiRegionConsistency`: [MultiRegionConsistency](/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb.MultiRegionConsistency.html) = MultiRegionConsistency.EVENTUAL — Specifies the consistency mode for a new global table.

- `partitionKey`: [Attribute](/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb.Attribute.html) (required) — Partition key attribute definition.

- `pointInTimeRecovery`: boolean — use `pointInTimeRecoverySpecification` instead

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

- `pointInTimeRecoverySpecification`: [PointInTimeRecoverySpecification](/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb.PointInTimeRecoverySpecification.html) — Whether point-in-time recovery is enabled and recoveryPeriodInDays is set.

  **Default:** point in time recovery is not enabled.

- `removalPolicy`: [RemovalPolicy](/cdk/api/v2/docs/aws-cdk-lib.RemovalPolicy.html) = RemovalPolicy.RETAIN — The removal policy applied to the table.

- `replicas`: [ReplicaTableProps](/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb.ReplicaTableProps.html)[] — Replica tables to deploy with the primary table.

  **Default:** no replica tables

  Note: Adding replica tables allows you to use your table as a global table. You
  cannot specify a replica table in the region that the primary table will be deployed
  to. Replica tables will only be supported if the stack deployment region is defined.

- `resourcePolicy`: [PolicyDocument](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.PolicyDocument.html) — Resource policy to assign to DynamoDB Table.

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

- `sortKey`: [Attribute](/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb.Attribute.html) — Sort key attribute definition.

  **Default:** no sort key

- `streamResourcePolicy`: [PolicyDocument](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.PolicyDocument.html) — Resource policy to assign to DynamoDB Stream.

  **Default:** No resource policy statements are added to the stream.

- `tableClass`: [TableClass](/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb.TableClass.html) = TableClass.STANDARD — The table class.

- `tableName`: string — The name of the table.

  **Default:** generated by CloudFormation

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — Tags to be applied to the primary table (default replica table).

  **Default:** no tags

- `timeToLiveAttribute`: string — The name of the TTL attribute.

  **Default:** TTL is disabled

- `warmThroughput`: [WarmThroughput](/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb.WarmThroughput.html) — The warm throughput configuration for the table.

  **Default:** no warm throughput is configured

- `witnessRegion`: string — The witness Region for the MRSC global table.

  **Default:** no witness region

  A MRSC global table can be configured with either three replicas, or with two replicas and one witness.

  Note: Witness region cannot be specified for a Multi-Region Eventual Consistency (MREC) Global Table.
  Witness regions are only supported for Multi-Region Strong Consistency (MRSC) Global Tables.

## Properties

- `encryptionKey`: [IKey](/cdk/api/v2/docs/aws-cdk-lib.aws_kms.IKey.html) — The KMS encryption key for the table.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `grants`: [TableGrants](/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb.TableGrants.html) — Grants for this table.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `PROPERTY_INJECTION_ID`: string (static) — Uniquely identifies this class.

- `resourcePolicy`: [PolicyDocument](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.PolicyDocument.html) — The resource policy for the table.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this resource is defined.

- `streamResourcePolicy`: [PolicyDocument](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.PolicyDocument.html) — Resource policy associated with this table's stream.

- `tableArn`: string — The ARN of the table.

- `tableId`: string — The ID of the table.

- `tableName`: string — The name of the table.

- `tableRef`: [TableReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_dynamodb.TableReference.html) — A reference to this table.

- `tableStreamArn`: string — The stream ARN of the table.

## Methods

- `addGlobalSecondaryIndex(props: GlobalSecondaryIndexPropsV2): void` — Add a global secondary index to the table.

  Note: Global secondary indexes will be inherited by all replica tables.

  **Parameters**

  - `props` — the properties of the global secondary index.

- `addLocalSecondaryIndex(props: LocalSecondaryIndexProps): void` — Add a local secondary index to the table.

  Note: Local secondary indexes will be inherited by all replica tables.

  **Parameters**

  - `props` — the properties of the local secondary index.

- `addReplica(props: ReplicaTableProps): void` — Add a replica table.

  Note: Adding a replica table will allow you to use your table as a global table.

  **Parameters**

  - `props` — the properties of the replica table to add.

- `addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult` — Adds a statement to the resource policy associated with this table.

  A resource policy will be automatically created upon the first call to `addToResourcePolicy`.

  Note that this does not work with imported tables.

  **Parameters**

  - `statement` — The policy statement to add.

- `addToStreamResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult` — Adds a statement to the resource policy associated with this table's stream.

  A stream resource policy will be automatically created upon the first call to `addToStreamResourcePolicy`.

  Note that this does not work with imported tables.

  **Parameters**

  - `statement` — The policy statement to add.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `fromTableArn(scope: Construct, id: string, tableArn: string): ITableV2` (static) — Creates a Table construct that represents an external table via table ARN.

  **Parameters**

  - `scope` — the parent creating construct (usually `this`).
  - `id` — the construct's name.
  - `tableArn` — the table's ARN.

- `fromTableAttributes(scope: Construct, id: string, attrs: TableAttributesV2): ITableV2` (static) — Creates a Table construct that represents an external table.

  **Parameters**

  - `scope` — the parent creating construct (usually `this`).
  - `id` — the construct's name.
  - `attrs` — attributes of the table.

- `fromTableName(scope: Construct, id: string, tableName: string): ITableV2` (static) — Creates a Table construct that represents an external table via table name.

  **Parameters**

  - `scope` — the parent creating construct (usually `this`).
  - `id` — the construct's name.
  - `tableName` — the table's name.

- `grant(grantee: IGrantable, ...actions: string[]): Grant` — Adds an IAM policy statement associated with this table to an IAM principal's policy.

  Note: If `encryptionKey` is present, appropriate grants to the key needs to be added
  separately using the `table.encryptionKey.grant*` methods.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — the principal (no-op if undefined).
  - `actions` — the set of actions to allow (i.e., 'dynamodb:PutItem', 'dynamodb:GetItem', etc.).

- `grantFullAccess(grantee: IGrantable): Grant` — Permits an IAM principal to all DynamoDB operations ('dynamodb:*') on this table.

  Note: Appropriate grants will also be added to the customer-managed KMS keys associated with this
  table if one was configured.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — the principal to grant access to.

- `grantOnKey(grantee: IGrantable, ...actions: string[]): GrantOnKeyResult` — Grants permissions on the table's encryption key.

  **Parameters**

  - `grantee` — the principal to grant access to.
  - `actions` — the KMS actions to grant.

- `grantReadData(grantee: IGrantable): Grant` — Permits an IAM principal all data read operations on this table.

  Actions: BatchGetItem, GetRecords, GetShardIterator, Query, GetItem, Scan, DescribeTable.

  Note: Appropriate grants will also be added to the customer-managed KMS keys associated with this
  table if one was configured.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — the principal to grant access to.

- `grantReadWriteData(grantee: IGrantable): Grant` — Permits an IAM principal to all data read/write operations on this table.

  Actions: BatchGetItem, GetRecords, GetShardIterator, Query, GetItem, Scan, BatchWriteItem, PutItem, UpdateItem,
  DeleteItem, DescribeTable.

  Note: Appropriate grants will also be added to the customer-managed KMS keys associated with this
  table if one was configured.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — the principal to grant access to.

- `grantStream(grantee: IGrantable, ...actions: string[]): Grant` — Adds an IAM policy statement associated with this table to an IAM principal's policy.

  Note: If `encryptionKey` is present, appropriate grants to the key needs to be added
  separately using the `table.encryptionKey.grant*` methods.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — the principal (no-op if undefined).
  - `actions` — the set of actions to allow (i.e., 'dynamodb:DescribeStream', 'dynamodb:GetRecords', etc.).

- `grantStreamRead(grantee: IGrantable): Grant` — Adds an IAM policy statement associated with this table to an IAM principal's policy.

  Actions: DescribeStream, GetRecords, GetShardIterator, ListStreams.

  Note: Appropriate grants will also be added to the customer-managed KMS keys associated with this
  table if one was configured.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — the principal to grant access to.

- `grantTableListStreams(grantee: IGrantable): Grant` — Permits an IAM principal to list streams attached to this table.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — the principal to grant access to.

- `grantWriteData(grantee: IGrantable): Grant` — Permits an IAM principal all data write operations on this table.

  Actions: BatchWriteItem, PutItem, UpdateItem, DeleteItem, DescribeTable.

  Note: Appropriate grants will also be added to the customer-managed KMS keys associated with this
  table if one was configured.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — the principal to grant access to.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `metric(metricName: string, props?: MetricOptions): Metric` — Return the given named metric for this table.

  By default, the metric will be calculated as a sum over a period of 5 minutes.
  You can customize this by using the `statistic` and `period` properties.

- `metricConditionalCheckFailedRequests(props?: MetricOptions): Metric` — Metric for the conditional check failed requests for this table.

  By default, the metric will be calculated as a sum over a period of 5 minutes.
  You can customize this by using the `statistic` and `period` properties.

- `metricConsumedReadCapacityUnits(props?: MetricOptions): Metric` — Metric for the consumed read capacity units for this table.

  By default, the metric will be calculated as a sum over a period of 5 minutes.
  You can customize this by using the `statistic` and `period` properties.

- `metricConsumedWriteCapacityUnits(props?: MetricOptions): Metric` — Metric for the consumed write capacity units for this table.

  By default, the metric will be calculated as a sum over a period of 5 minutes.
  You can customize this by using the `statistic` and `period` properties.

- `metricSuccessfulRequestLatency(props?: MetricOptions): Metric` — Metric for the successful request latency for this table.

  By default, the metric will be calculated as an average over a period of 5 minutes.
  You can customize this by using the `statistic` and `period` properties.

- `metricSystemErrors(props?: MetricOptions): Metric` — use `metricSystemErrorsForOperations`.

- `metricSystemErrorsForOperations(props?: SystemErrorsForOperationsMetricOptions): IMetric` — Metric for the system errors for this table. This will sum errors across all possible operations.

  By default, each individual metric will be calculated as a sum over a period of 5 minutes.
  You can customize this by using the `statistic` and `period` properties.

- `metricThrottledRequests(props?: MetricOptions): Metric` — Do not use this function. It returns an invalid metric. Use `metricThrottledRequestsForOperation` instead.

  By default, each individual metric will be calculated as a sum over a period of 5 minutes.
  You can customize this by using the `statistic` and `period` properties.

- `metricThrottledRequestsForOperation(operation: string, props?: OperationsMetricOptions): IMetric` — How many requests are throttled on this table for the given operation.

  By default, the metric will be calculated as an average over a period of 5 minutes.
  You can customize this by using the `statistic` and `period` properties.

- `metricThrottledRequestsForOperations(props?: OperationsMetricOptions): IMetric` — How many requests are throttled on this table. This will sum errors across all possible operations.

  By default, each individual metric will be calculated as a sum over a period of 5 minutes.
  You can customize this by using the `statistic` and `period` properties.

- `metricUserErrors(props?: MetricOptions): Metric` — Metric for the user errors for this table.

  Note: This metric reports user errors across all the tables in the account and region the table
  resides in.

  By default, the metric will be calculated as a sum over a period of 5 minutes.
  You can customize this by using the `statistic` and `period` properties.

- `replica(region: string): ITableV2` — Retrieve a replica table.

  Note: Replica tables are not supported in a region agnostic stack.

  **Parameters**

  - `region` — the region of the replica table.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.