AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 3.5
 
Represents the properties of a global secondary index.

Inheritance Hierarchy

System.Object
  Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription

Namespace: Amazon.DynamoDBv2.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class GlobalSecondaryIndexDescription : Object

The GlobalSecondaryIndexDescription type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property Backfilling System.Boolean 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.

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

Public Property IndexArn System.String Gets and sets the property IndexArn.

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

Public Property IndexName System.String Gets and sets the property IndexName.

The name of the global secondary index.

Public Property IndexSizeBytes System.Int64 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 Property IndexStatus Amazon.DynamoDBv2.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 Property ItemCount System.Int64 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 Property KeySchema System.Collections.Generic.List<Amazon.DynamoDBv2.Model.KeySchemaElement> 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

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.

Public Property Projection Amazon.DynamoDBv2.Model.Projection Gets and sets the property Projection.
Public Property ProvisionedThroughput Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription Gets and sets the property ProvisionedThroughput.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8