AWS SDK Version 3 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.

Represents the properties of a global secondary index.

Inheritance Hierarchy

System.Object
  Amazon.DynamoDBv2.Model.GlobalSecondaryIndex

Namespace: Amazon.DynamoDBv2.Model
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z

Syntax

C#
public class GlobalSecondaryIndex

The GlobalSecondaryIndex type exposes the following members

Constructors

NameDescription
Public Method GlobalSecondaryIndex()

Properties

NameTypeDescription
Public Property IndexName System.String

Gets and sets the property IndexName.

The name of the global secondary index. The name must be unique among all other indexes on this table.

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'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 Property Projection Amazon.DynamoDBv2.Model.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 Property ProvisionedThroughput Amazon.DynamoDBv2.Model.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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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