Class CfnTable.GlobalSecondaryIndexProperty

Represents the properties of a global secondary index.

Inheritance
System.Object
CfnTable.GlobalSecondaryIndexProperty
Namespace: Amazon.CDK.AWS.DynamoDB
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class GlobalSecondaryIndexProperty : Object, CfnTable.IGlobalSecondaryIndexProperty
Syntax (vb)
Public Class GlobalSecondaryIndexProperty
    Inherits Object
    Implements CfnTable.IGlobalSecondaryIndexProperty
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-globalsecondaryindex.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DynamoDB;

var globalSecondaryIndexProperty = new GlobalSecondaryIndexProperty {
    IndexName = "indexName",
    KeySchema = new [] { new KeySchemaProperty {
        AttributeName = "attributeName",
        KeyType = "keyType"
    } },
    Projection = new ProjectionProperty {
        NonKeyAttributes = new [] { "nonKeyAttributes" },
        ProjectionType = "projectionType"
    },

    // the properties below are optional
    ContributorInsightsSpecification = new ContributorInsightsSpecificationProperty {
        Enabled = false
    },
    OnDemandThroughput = new OnDemandThroughputProperty {
        MaxReadRequestUnits = 123,
        MaxWriteRequestUnits = 123
    },
    ProvisionedThroughput = new ProvisionedThroughputProperty {
        ReadCapacityUnits = 123,
        WriteCapacityUnits = 123
    },
    WarmThroughput = new WarmThroughputProperty {
        ReadUnitsPerSecond = 123,
        WriteUnitsPerSecond = 123
    }
};

Synopsis

Constructors

GlobalSecondaryIndexProperty()

Properties

ContributorInsightsSpecification

The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index.
IndexName

The name of the global secondary index.
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 .
OnDemandThroughput

The maximum number of read and write units for the specified global secondary index.
Projection

Represents attributes that are copied (projected) from the table into the global secondary index.
ProvisionedThroughput

Represents the provisioned throughput settings for the specified global secondary index.
WarmThroughput

Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index.

Constructors

GlobalSecondaryIndexProperty()

public GlobalSecondaryIndexProperty()

Properties

ContributorInsightsSpecification

The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index.

public object ContributorInsightsSpecification { get; set; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-globalsecondaryindex.html#cfn-dynamodb-table-globalsecondaryindex-contributorinsightsspecification

IndexName

The name of the global secondary index.

public string IndexName { get; set; }
Property Value

System.String

Remarks

The name must be unique among all other indexes on this table.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-globalsecondaryindex.html#cfn-dynamodb-table-globalsecondaryindex-indexname

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 .

public object KeySchema { get; set; }
Property Value

System.Object

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-globalsecondaryindex.html#cfn-dynamodb-table-globalsecondaryindex-keyschema

OnDemandThroughput

The maximum number of read and write units for the specified global secondary index.

public object OnDemandThroughput { get; set; }
Property Value

System.Object

Remarks

If you use this parameter, you must specify MaxReadRequestUnits , MaxWriteRequestUnits , or both.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-globalsecondaryindex.html#cfn-dynamodb-table-globalsecondaryindex-ondemandthroughput

Projection

Represents attributes that are copied (projected) from the table into the global secondary index.

public object Projection { get; set; }
Property Value

System.Object

Remarks

These are in addition to the primary key attributes and index key attributes, which are automatically projected.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-globalsecondaryindex.html#cfn-dynamodb-table-globalsecondaryindex-projection

ProvisionedThroughput

Represents the provisioned throughput settings for the specified global secondary index.

public object ProvisionedThroughput { get; set; }
Property Value

System.Object

Remarks

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-globalsecondaryindex.html#cfn-dynamodb-table-globalsecondaryindex-provisionedthroughput

WarmThroughput

Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index.

public object WarmThroughput { get; set; }
Property Value

System.Object

Remarks

If you use this parameter, you must specify ReadUnitsPerSecond , WriteUnitsPerSecond , or both.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-globalsecondaryindex.html#cfn-dynamodb-table-globalsecondaryindex-warmthroughput

Implements