AWSDynamoDBGlobalSecondaryIndex

Objective-C

@interface AWSDynamoDBGlobalSecondaryIndex

Swift

class AWSDynamoDBGlobalSecondaryIndex

Represents the properties of a global secondary index.

Required parameters: [IndexName, KeySchema, Projection]

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable indexName;

    Swift

    var indexName: String? { get set }

  • 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’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.

    Declaration

    Objective-C

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

    Swift

    var keySchema: [AWSDynamoDBKeySchemaElement]? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSDynamoDBProjection *_Nullable projection;

    Swift

    var projection: AWSDynamoDBProjection? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSDynamoDBProvisionedThroughput *_Nullable provisionedThroughput;

    Swift

    var provisionedThroughput: AWSDynamoDBProvisionedThroughput? { get set }