GlobalSecondaryIndex

import type { GlobalSecondaryIndex } from "https://aws-api.deno.dev/v0.3/services/dynamodb.ts?docs=full";

Represents the properties of a global secondary index.

interface GlobalSecondaryIndex {

IndexName: string;

KeySchema: KeySchemaElement[];

Projection: Projection;

ProvisionedThroughput?: ProvisionedThroughput | null;

}

§Properties

IndexName: string

[src]

The name of the global secondary index. The name must be unique among all other indexes on this table.

KeySchema: KeySchemaElement[]

[src]

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

HASH - partition key
RANGE - sort key

Note: 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: Projection

[src]

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

ProvisionedThroughput?: ProvisionedThroughput | null

[src]

Represents the provisioned throughput settings for the specified global secondary index.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.