interface TableAttributes

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

Reference to 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 tableAttributes: dynamodb.TableAttributes = {
  encryptionKey: key,
  globalIndexes: ['globalIndexes'],
  grantIndexPermissions: false,
  localIndexes: ['localIndexes'],
  tableArn: 'tableArn',
  tableName: 'tableName',
  tableStreamArn: 'tableStreamArn',
};

Properties

Name	Type	Description
encryptionKey?	IKey	KMS encryption key, if this table uses a customer-managed encryption key.
globalIndexes?	string[]	The name of the global indexes set for this Table.
grantIndexPermissions?	boolean	If set to true, grant methods always grant permissions for all indexes.
localIndexes?	string[]	The name of the local indexes set for this Table.
tableArn?	string	The ARN of the dynamodb table.
tableName?	string	The table name of the dynamodb table.
tableStreamArn?	string	The ARN of the table's stream.

---

encryptionKey?

Type: IKey (optional, default: no key)

KMS encryption key, if this table uses a customer-managed encryption key.

---

globalIndexes?

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

The name of the global indexes set for this Table.

Note that you need to set either this property, or localIndexes, if you want methods like grantReadData() to grant permissions for indexes as well as the table itself.

---

grantIndexPermissions?

Type: boolean (optional, default: false)

If set to true, grant methods always grant permissions for all indexes.

If false is provided, grant methods grant the permissions only when globalIndexes or localIndexes is specified.

---

localIndexes?

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

The name of the local indexes set for this Table.

Note that you need to set either this property, or globalIndexes, if you want methods like grantReadData() to grant permissions for indexes as well as the table itself.

---

tableArn?

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

The ARN of the dynamodb table.

One of this, or tableName, is required.

---

tableName?

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

The table name of the dynamodb table.

One of this, or tableArn, is required.

---

tableStreamArn?

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

The ARN of the table's stream.