interface GlobalSecondaryIndexPropsV2

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

Properties used to configure a global secondary index.

Example

const table = new dynamodb.TableV2(this, 'Table', {
  partitionKey: { name: 'pk', type: dynamodb.AttributeType.STRING },
  globalSecondaryIndexes: [
    {
      indexName: 'gsi1',
      partitionKey: { name: 'pk', type: dynamodb.AttributeType.STRING },
    },
  ],
});

table.addGlobalSecondaryIndex({
  indexName: 'gsi2',
  partitionKey: { name: 'pk', type: dynamodb.AttributeType.STRING },
});

Properties

Name	Type	Description
indexName	string	The name of the secondary index.
partitionKey	Attribute	Partition key attribute definition.
maxReadRequestUnits?	number	The maximum read request units.
maxWriteRequestUnits?	number	The maximum write request units.
nonKeyAttributes?	string[]	The non-key attributes that are projected into the secondary index.
projectionType?	ProjectionType	The set of attributes that are projected into the secondary index.
readCapacity?	Capacity	The read capacity.
sortKey?	Attribute	Sort key attribute definition.
warmThroughput?	WarmThroughput	The warm throughput configuration for the global secondary index.
writeCapacity?	Capacity	The write capacity.

---

indexName

Type: string

The name of the secondary index.

---

partitionKey

Type: Attribute

Partition key attribute definition.

---

maxReadRequestUnits?

Type: number (optional, default: inherited from the primary table.)

The maximum read request units.

Note: This can only be configured if the primary table billing is PAY_PER_REQUEST.

---

maxWriteRequestUnits?

Type: number (optional, default: inherited from the primary table.)

The maximum write request units.

Note: This can only be configured if the primary table billing is PAY_PER_REQUEST.

---

nonKeyAttributes?

Type: string[] (optional, default: No additional attributes)

The non-key attributes that are projected into the secondary index.

---

projectionType?

Type: ProjectionType (optional, default: ALL)

The set of attributes that are projected into the secondary index.

---

readCapacity?

Type: Capacity (optional, default: inherited from the primary table.)

The read capacity.

Note: This can only be configured if the primary table billing is provisioned.

---

sortKey?

Type: Attribute (optional, default: no sort key)

Sort key attribute definition.

---

warmThroughput?

Type: WarmThroughput (optional, default: no warm throughput is configured)

The warm throughput configuration for the global secondary index.

---

writeCapacity?

Type: Capacity (optional, default: inherited from the primary table.)

The write capacity.

Note: This can only be configured if the primary table billing is provisioned.