Class GlobalSecondaryIndexDescription

Namespace

Amazon.DynamoDBv2.Model

Assembly

AWSSDK.DynamoDBv2.dll

Represents the properties of a global secondary index.

public class GlobalSecondaryIndexDescription

Inheritance

object

GlobalSecondaryIndexDescription

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

GlobalSecondaryIndexDescription()

public GlobalSecondaryIndexDescription()

Properties

Backfilling

Gets and sets the property 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.

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.

note

For indexes that were created during a

CreateTable

operation, the

Backfilling

attribute does not appear in the

DescribeTable

output.

public bool Backfilling { get; set; }

Property Value

bool

IndexArn

Gets and sets the property IndexArn.

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

public string IndexArn { get; set; }

Property Value

string

IndexName

Gets and sets the property IndexName.

The name of the global secondary index.

public string IndexName { get; set; }

Property Value

string

IndexSizeBytes

Gets and sets the property 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.

public long IndexSizeBytes { get; set; }

Property Value

long

IndexStatus

Gets and sets the property 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.

public IndexStatus IndexStatus { get; set; }

Property Value

IndexStatus

ItemCount

Gets and sets the property 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.

public long ItemCount { get; set; }

Property Value

long

KeySchema

Gets and sets the property 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

note

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.

public List<KeySchemaElement> KeySchema { get; set; }

Property Value

List<KeySchemaElement>

Projection

Gets and sets the property Projection.

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.

public Projection Projection { get; set; }

Property Value

Projection

ProvisionedThroughput

Gets and sets the property ProvisionedThroughput.

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.

public ProvisionedThroughputDescription ProvisionedThroughput { get; set; }

Property Value

ProvisionedThroughputDescription