Amazon DynamoDB · Schema

GlobalSecondaryIndex

Represents the properties of a global secondary index

DatabaseDocument StoreKey-ValueNoSQLServerless

Properties

Name Type Description
IndexName string The name of the global secondary index
KeySchema array The complete key schema for the index
Projection object
ProvisionedThroughput object
View JSON Schema on GitHub

JSON Schema

dynamodb-openapi-global-secondary-index-schema.json Raw ↑
{
  "$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-global-secondary-index-schema.json",
  "title": "GlobalSecondaryIndex",
  "description": "Represents the properties of a global secondary index",
  "type": "object",
  "properties": {
    "IndexName": {
      "type": "string",
      "description": "The name of the global secondary index"
    },
    "KeySchema": {
      "type": "array",
      "description": "The complete key schema for the index",
      "items": {
        "$ref": "#/components/schemas/KeySchemaElement"
      },
      "minItems": 1,
      "maxItems": 2
    },
    "Projection": {
      "$ref": "#/components/schemas/Projection"
    },
    "ProvisionedThroughput": {
      "$ref": "#/components/schemas/ProvisionedThroughput"
    }
  },
  "required": [
    "IndexName",
    "KeySchema",
    "Projection"
  ]
}