# TableBaseV2

Base class for a DynamoDB table.

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

- Source: [`aws-dynamodb/lib/table-v2-base.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-dynamodb/lib/table-v2-base.ts#L36)
- Type last changed: v2.239.0 · 19 Feb 2026

## Initializer

```ts
new TableBaseV2(scope: Construct, id: string, props?: ResourceProps)
```

## Construct Props

- `account`: string — The AWS account ID this resource belongs to.

  **Default:** the resource is in the same account as the stack it belongs to

- `environmentFromArn`: string — ARN to deduce region and account from.

  **Default:** take environment from `account`, `region` parameters, or use Stack environment.

  The ARN is parsed and the account and region are taken from the ARN.
  This should be used for imported resources.

  Cannot be supplied together with either `account` or `region`.

- `physicalName`: string — The value passed in by users to the physical name prop of the resource.

  **Default:** The physical name will be allocated by CloudFormation at deployment time

  - `undefined` implies that a physical name will be allocated by
    CloudFormation during deployment.
  - a concrete value implies a specific physical name
  - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated
    by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.

- `region`: string — The AWS region this resource belongs to.

  **Default:** the resource is in the same region as the stack it belongs to

## 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.

- `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.

- `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

- `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.

- `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`).

- `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.

- `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.