AWSDynamoDBGlobalSecondaryIndex Class Reference

Inherits from AWSModel : AWSMTLModel
Declared in AWSDynamoDBModel.h


Represents the properties of a global secondary index.

Required parameters: [IndexName, KeySchema, Projection, ProvisionedThroughput]


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

@property (nonatomic, strong) NSString *indexName

Declared In



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

The partition key of an item is also known as its hash attribute. The term “hash attribute” derives from DynamoDB' 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.

@property (nonatomic, strong) NSArray<AWSDynamoDBKeySchemaElement*> *keySchema

Declared In



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

@property (nonatomic, strong) AWSDynamoDBProjection *projection

Declared In



Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

@property (nonatomic, strong) AWSDynamoDBProvisionedThroughput *provisionedThroughput

Declared In