AWSDynamoDBGlobalSecondaryIndexDescription

Objective-C

@interface AWSDynamoDBGlobalSecondaryIndexDescription

Swift

class AWSDynamoDBGlobalSecondaryIndexDescription

Represents the properties of a global secondary index.

  • Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.

    You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can’t delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false.

    For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable backfilling;

    Swift

    var backfilling: NSNumber? { get set }

  • The Amazon Resource Name (ARN) that uniquely identifies the index.

    Declaration

    Objective-C

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

    Swift

    var indexArn: String? { get set }

  • The name of the global secondary index.

    Declaration

    Objective-C

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

    Swift

    var indexName: String? { get set }

  • The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable indexSizeBytes;

    Swift

    var indexSizeBytes: NSNumber? { get set }

  • The current state of the global secondary index:

    • CREATING - The index is being created.

    • UPDATING - The index is being updated.

    • DELETING - The index is being deleted.

    • ACTIVE - The index is ready for use.

    Declaration

    Objective-C

    @property (nonatomic) AWSDynamoDBIndexStatus indexStatus;

    Swift

    var indexStatus: AWSDynamoDBIndexStatus { get set }

  • The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable itemCount;

    Swift

    var itemCount: NSNumber? { 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 }

  • The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSDynamoDBOnDemandThroughput *_Nullable onDemandThroughput;

    Swift

    var onDemandThroughput: AWSDynamoDBOnDemandThroughput? { 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) AWSDynamoDBProvisionedThroughputDescription *_Nullable provisionedThroughput;

    Swift

    var provisionedThroughput: AWSDynamoDBProvisionedThroughputDescription? { get set }