class TableBaseV2

Language	Type name
.NET	`Amazon.CDK.AWS.DynamoDB.TableBaseV2`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsdynamodb#TableBaseV2`
Java	`software.amazon.awscdk.services.dynamodb.TableBaseV2`
Python	`aws_cdk.aws_dynamodb.TableBaseV2`
TypeScript (source)	`aws-cdk-lib` » `aws_dynamodb` » `TableBaseV2`

Implements IConstruct, IDependable, IResource, IEnvironmentAware, ITableV2, ITable, IResourceWithPolicy, IResourceWithPolicyV2

Extends Resource

Implemented by TableV2

Base class for a DynamoDB table.

Initializer

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

Parameters

scope Construct
id string
props ResourceProps

Properties

Name	Type	Description
env	`ResourceEnvironment`	The environment this resource belongs to.
hasIndex	`boolean`
node	`Node`	The tree node.
region	`string`
stack	`Stack`	The stack in which this resource is defined.
tableArn	`string`	The ARN of the table.
tableName	`string`	The name of the table.
encryptionKey?	`IKey`	The KMS encryption key for the table.
resourcePolicy?	`PolicyDocument`	The resource policy for the table.
tableId?	`string`	The ID of the table.
tableStreamArn?	`string`	The stream ARN of the table.

env

Type: ResourceEnvironment

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.

hasIndex

Type: boolean

node

Type: Node

The tree node.

region

Type: string

stack

Type: Stack

The stack in which this resource is defined.

tableArn

Type: string

The ARN of the table.

tableName

Type: string

The name of the table.

encryptionKey?

Type: IKey (optional)

The KMS encryption key for the table.

resourcePolicy?

Type: PolicyDocument (optional)

The resource policy for the table.

tableId?

Type: string (optional)

The ID of the table.

tableStreamArn?

Type: string (optional)

The stream ARN of the table.

Methods

Name	Description
addToResourcePolicy(statement)	Adds a statement to the resource policy associated with this table.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
grant(grantee, ...actions)	Adds an IAM policy statement associated with this table to an IAM principal's policy.
grantFullAccess(grantee)	Permits an IAM principal to all DynamoDB operations ('dynamodb:*') on this table.
grantReadData(grantee)	Permits an IAM principal all data read operations on this table.
grantReadWriteData(grantee)	Permits an IAM principal to all data read/write operations on this table.
grantStream(grantee, ...actions)	Adds an IAM policy statement associated with this table to an IAM principal's policy.
grantStreamRead(grantee)	Adds an IAM policy statement associated with this table to an IAM principal's policy.
grantTableListStreams(grantee)	Permits an IAM principal to list streams attached to this table.
grantWriteData(grantee)	Permits an IAM principal all data write operations on this table.
metric(metricName, props?)	Return the given named metric for this table.
metricConditionalCheckFailedRequests(props?)	Metric for the conditional check failed requests for this table.
metricConsumedReadCapacityUnits(props?)	Metric for the consumed read capacity units for this table.
metricConsumedWriteCapacityUnits(props?)	Metric for the consumed write capacity units for this table.
metricSuccessfulRequestLatency(props?)	Metric for the successful request latency for this table.
metricSystemErrors(props?)⚠️	Metric for the system errors this table.
metricSystemErrorsForOperations(props?)	Metric for the system errors for this table. This will sum errors across all possible operations.
metricThrottledRequests(props?)⚠️	How many requests are throttled on this table.
metricThrottledRequestsForOperation(operation, props?)	How many requests are throttled on this table for the given operation.
metricThrottledRequestsForOperations(props?)	How many requests are throttled on this table. This will sum errors across all possible operations.
metricUserErrors(props?)	Metric for the user errors for this table.
toString()	Returns a string representation of this construct.

addToResourcePolicy(statement)

public addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult

Parameters

statement PolicyStatement — The policy statement to add.

Returns

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.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

policy RemovalPolicy

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, ...actions)

public grant(grantee: IGrantable, ...actions: string[]): Grant

Parameters

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

Returns

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.

grantFullAccess(grantee)

public grantFullAccess(grantee: IGrantable): Grant

Parameters

grantee IGrantable — the principal to grant access to.

Returns

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.

grantReadData(grantee)

public grantReadData(grantee: IGrantable): Grant

Parameters

grantee IGrantable — the principal to grant access to.

Returns

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.

grantReadWriteData(grantee)

public grantReadWriteData(grantee: IGrantable): Grant

Parameters

grantee IGrantable — the principal to grant access to.

Returns

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.

grantStream(grantee, ...actions)

public grantStream(grantee: IGrantable, ...actions: string[]): Grant

Parameters

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

Returns

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.

grantStreamRead(grantee)

public grantStreamRead(grantee: IGrantable): Grant

Parameters

grantee IGrantable — the principal to grant access to.

Returns

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.

grantTableListStreams(grantee)

public grantTableListStreams(grantee: IGrantable): Grant

Parameters

grantee IGrantable — the principal to grant access to.

Returns

Grant

Permits an IAM principal to list streams attached to this table.

grantWriteData(grantee)

public grantWriteData(grantee: IGrantable): Grant

Parameters

grantee IGrantable — the principal to grant access to.

Returns

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.

metric(metricName, props?)

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

metricName string
props MetricOptions

Returns

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?)

public metricConditionalCheckFailedRequests(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

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?)

public metricConsumedReadCapacityUnits(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

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?)

public metricConsumedWriteCapacityUnits(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

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?)

public metricSuccessfulRequestLatency(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

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?)⚠️

public metricSystemErrors(props?: MetricOptions): Metric

⚠️ Deprecated: use metricSystemErrorsForOperations.

Parameters

props MetricOptions

Returns

Metric

Metric for the system errors this table.

metricSystemErrorsForOperations(props?)

public metricSystemErrorsForOperations(props?: SystemErrorsForOperationsMetricOptions): IMetric

Parameters

props SystemErrorsForOperationsMetricOptions

Returns

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?)⚠️

public metricThrottledRequests(props?: MetricOptions): Metric

⚠️ Deprecated: Do not use this function. It returns an invalid metric. Use metricThrottledRequestsForOperation instead.

Parameters

props MetricOptions

Returns

Metric

How many requests are throttled on this table.

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, props?)

public metricThrottledRequestsForOperation(operation: string, props?: OperationsMetricOptions): IMetric

Parameters

operation string
props OperationsMetricOptions

Returns

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?)

public metricThrottledRequestsForOperations(props?: OperationsMetricOptions): IMetric

Parameters

props OperationsMetricOptions

Returns

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?)

public metricUserErrors(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

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()

public toString(): string

Returns

string

Returns a string representation of this construct.