Type alias SecondaryIndexLayout

SecondaryIndexLayout: {
    indexName: string;
    partitionKey: string;
    sortKey?: string;
}

The structure of a Global Secondary Index

Type declaration

indexName: string

The name of the secondary index
partitionKey: string

The name of the secondary index partition key
Optional sortKey?: string

The name of the secondary index sort key. If your index does not have one, leave this as undefined

Generated using TypeDoc