interface LocalSecondaryIndexProperty

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

Represents the properties of a local secondary index.

A local secondary index can only be created when its parent table is created.

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';
const localSecondaryIndexProperty: dynamodb.CfnGlobalTable.LocalSecondaryIndexProperty = {
  indexName: 'indexName',
  keySchema: [{
    attributeName: 'attributeName',
    keyType: 'keyType',
  }],
  projection: {
    nonKeyAttributes: ['nonKeyAttributes'],
    projectionType: 'projectionType',
  },
};

Properties

Name	Type	Description
indexName	`string`	The name of the local secondary index.
keySchema	`IResolvable` `\|` `IResolvable` `\|` `KeySchemaProperty[]`	The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: - `HASH` - partition key - `RANGE` - sort key > The partition key of an item is also known as its hash attribute .
projection	`IResolvable` `\|` `ProjectionProperty`	Represents attributes that are copied (projected) from the table into the local secondary index.

indexName

Type: string

The name of the local secondary index.

The name must be unique among all other indexes on this table.

keySchema

Type: IResolvable | IResolvable | KeySchemaProperty[]

The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: - HASH - partition key - RANGE - sort key > The partition key of an item is also known as its hash attribute .

The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute . The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

projection

Type: IResolvable | ProjectionProperty

Represents attributes that are copied (projected) from the table into the local secondary index.

These are in addition to the primary key attributes and index key attributes, which are automatically projected.