AwsDynamodbGlobalSecondaryIndexProjectionArgs

interface AwsDynamodbGlobalSecondaryIndexProjectionArgs {
nonKeyAttributes?: string[];
type: 'ALL' | 'KEYS_ONLY' | 'INCLUDE';
}

GSI projection configuration.

Example

CODE

const projection: AwsDynamodbGlobalSecondaryIndexProjectionArgs = {
  type: 'INCLUDE',
  nonKeyAttributes: ['status', 'createdAt'],
};

Properties

Additional projected attributes when type is INCLUDE.

Projection type for the index.