AWSDynamoDBGlobalSecondaryIndexDescription Class Reference

Inherits from AWSModel : AWSMTLModel
Declared in AWSDynamoDBModel.h
AWSDynamoDBModel.m

Overview

Represents the properties of a global secondary index.

  backfilling

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.

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

@property (nonatomic, strong) NSNumber *backfilling

Declared In

AWSDynamoDBModel.h

  indexArn

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

@property (nonatomic, strong) NSString *indexArn

Declared In

AWSDynamoDBModel.h

  indexName

The name of the global secondary index.

@property (nonatomic, strong) NSString *indexName

Declared In

AWSDynamoDBModel.h

  indexSizeBytes

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.

@property (nonatomic, strong) NSNumber *indexSizeBytes

Declared In

AWSDynamoDBModel.h

  indexStatus

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.

@property (nonatomic, assign) AWSDynamoDBIndexStatus indexStatus

Declared In

AWSDynamoDBModel.h

  itemCount

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.

@property (nonatomic, strong) NSNumber *itemCount

Declared In

AWSDynamoDBModel.h

  keySchema

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

AWSDynamoDBModel.h

  projection

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

AWSDynamoDBModel.h

  provisionedThroughput

Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

@property (nonatomic, strong) AWSDynamoDBProvisionedThroughputDescription *provisionedThroughput

Declared In

AWSDynamoDBModel.h