AWS SDK for .NET Documentation
GlobalSecondaryIndexDescription Class
AmazonAmazon.DynamoDBv2.ModelGlobalSecondaryIndexDescription Did this page help you?   Yes   No    Tell us about it...

Represents the properties of a global secondary index.

Declaration Syntax
C#
public class GlobalSecondaryIndexDescription
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
GlobalSecondaryIndexDescription()()()()
Initializes a new instance of the GlobalSecondaryIndexDescription class

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
IndexName
The name of the global secondary index.

Constraints:

Length
3 - 255
Pattern
[a-zA-Z0-9_.-]+


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.

IndexStatus
The current state of the global secondary index:
  • CREATING - The index is being created, as the result of a CreateTable or UpdateTable operation.
  • UPDATING - The index is being updated, as the result of a CreateTable or UpdateTable operation.
  • DELETING - The index is being deleted, as the result of a DeleteTable operation.
  • ACTIVE - The index is ready for use.

Constraints:

Allowed Values
CREATING, UPDATING, DELETING, ACTIVE


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.

KeySchema
The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types (HASH or RANGE).

Constraints:

Length
1 - 2


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.

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

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
WithIndexName(String) Obsolete.
Sets the IndexName property

WithIndexSizeBytes(Int64) Obsolete.
Sets the IndexSizeBytes property

WithIndexStatus(String) Obsolete.
Sets the IndexStatus property

WithItemCount(Int64) Obsolete.
Sets the ItemCount property

WithKeySchema(array<KeySchemaElement>[]()[][]) Obsolete.
Adds elements to the KeySchema collection

WithKeySchema(IEnumerable<(Of <<'(KeySchemaElement>)>>)) Obsolete.
Adds elements to the KeySchema collection

WithProjection(Projection) Obsolete.
Sets the Projection property

WithProvisionedThroughput(ProvisionedThroughputDescription) Obsolete.
Sets the ProvisionedThroughput property

Inheritance Hierarchy
Object
GlobalSecondaryIndexDescription

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)