LocalSecondaryIndex

Represents the properties of a local secondary index

DatabaseDocument StoreKey-ValueNoSQLServerless

Properties

Name	Type	Description
IndexName	string	The name of the local secondary index
KeySchema	array	The complete key schema for the index
Projection	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-dynamodb/refs/heads/main/json-schema/dynamodb-openapi-local-secondary-index-schema.json",
  "title": "LocalSecondaryIndex",
  "description": "Represents the properties of a local secondary index",
  "type": "object",
  "properties": {
    "IndexName": {
      "type": "string",
      "description": "The name of the local secondary index"
    },
    "KeySchema": {
      "type": "array",
      "description": "The complete key schema for the index",
      "items": {
        "$ref": "#/components/schemas/KeySchemaElement"
      },
      "minItems": 2,
      "maxItems": 2
    },
    "Projection": {
      "$ref": "#/components/schemas/Projection"
    }
  },
  "required": [
    "IndexName",
    "KeySchema",
    "Projection"
  ]
}