interface TableAttributesV2

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

Attributes of a DynamoDB table.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dynamodb as dynamodb } from 'aws-cdk-lib';
import { aws_kms as kms } from 'aws-cdk-lib';

declare const key: kms.Key;
const tableAttributesV2: dynamodb.TableAttributesV2 = {
  encryptionKey: key,
  globalIndexes: ['globalIndexes'],
  grantIndexPermissions: false,
  localIndexes: ['localIndexes'],
  tableArn: 'tableArn',
  tableId: 'tableId',
  tableName: 'tableName',
  tableStreamArn: 'tableStreamArn',
};

Properties

Name	Type	Description
encryptionKey?	IKey	KMS encryption key for the table.
globalIndexes?	string[]	The name of the global indexes set for the table.
grantIndexPermissions?	boolean	Whether or not to grant permissions for all indexes of the table.
localIndexes?	string[]	The name of the local indexes set for the table.
tableArn?	string	The ARN of the table.
tableId?	string	The ID of the table.
tableName?	string	The name of the table.
tableStreamArn?	string	The stream ARN of the table.

---

encryptionKey?

Type: IKey (optional, default: no KMS encryption key)

KMS encryption key for the table.

---

globalIndexes?

Type: string[] (optional, default: no global indexes)

The name of the global indexes set for the table.

Note: You must set either this property or localIndexes if you want permissions to be granted for indexes as well as the table itself.

---

grantIndexPermissions?

Type: boolean (optional, default: false)

Whether or not to grant permissions for all indexes of the table.

Note: If false, permissions will only be granted to indexes when globalIndexes or localIndexes is specified.

---

localIndexes?

Type: string[] (optional, default: no local indexes)

The name of the local indexes set for the table.

Note: You must set either this property or globalIndexes if you want permissions to be granted for indexes as well as the table itself.

---

tableArn?

Type: string (optional, default: table arn generated using tableName and region of stack)

The ARN of the table.

Note: You must specify this or the tableName.

---

tableId?

Type: string (optional, default: no table id)

The ID of the table.

---

tableName?

Type: string (optional, default: table name retrieved from provided tableArn)

The name of the table.

Note: You must specify this or the tableArn.

---

tableStreamArn?

Type: string (optional, default: no table stream ARN)

The stream ARN of the table.