Class CfnGlobalTable.LocalSecondaryIndexProperty

Represents the properties of a local secondary index.

Inheritance

object

CfnGlobalTable.LocalSecondaryIndexProperty

Implements

CfnGlobalTable.ILocalSecondaryIndexProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.DynamoDB

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnGlobalTable.LocalSecondaryIndexProperty : CfnGlobalTable.ILocalSecondaryIndexProperty

Syntax (vb)

Public Class CfnGlobalTable.LocalSecondaryIndexProperty Implements CfnGlobalTable.ILocalSecondaryIndexProperty

Remarks

A local secondary index can only be created when its parent table is created.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-localsecondaryindex.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 localSecondaryIndexProperty = new LocalSecondaryIndexProperty {
                 IndexName = "indexName",
                 KeySchema = new [] { new KeySchemaProperty {
                     AttributeName = "attributeName",
                     KeyType = "keyType"
                 } },
                 Projection = new ProjectionProperty {
                     NonKeyAttributes = new [] { "nonKeyAttributes" },
                     ProjectionType = "projectionType"
                 }
             };

Synopsis

Constructors

LocalSecondaryIndexProperty()

Represents the properties of a local secondary index.

Properties

IndexName	The name of the local secondary index.
KeySchema	The complete key schema for the local secondary index, consisting 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 .
Projection	Represents attributes that are copied (projected) from the table into the local secondary index.

Constructors

LocalSecondaryIndexProperty()

Represents the properties of a local secondary index.

public LocalSecondaryIndexProperty()

Remarks

A local secondary index can only be created when its parent table is created.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-localsecondaryindex.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 localSecondaryIndexProperty = new LocalSecondaryIndexProperty {
                 IndexName = "indexName",
                 KeySchema = new [] { new KeySchemaProperty {
                     AttributeName = "attributeName",
                     KeyType = "keyType"
                 } },
                 Projection = new ProjectionProperty {
                     NonKeyAttributes = new [] { "nonKeyAttributes" },
                     ProjectionType = "projectionType"
                 }
             };

Properties

IndexName

The name of the local secondary index.

public string IndexName { get; set; }

Property Value

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-globaltable-localsecondaryindex.html#cfn-dynamodb-globaltable-localsecondaryindex-indexname

KeySchema

The complete key schema for the local secondary index, consisting 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

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 <em>range attribute</em> . 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-globaltable-localsecondaryindex.html#cfn-dynamodb-globaltable-localsecondaryindex-keyschema

Projection

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

public object Projection { get; set; }

Property Value

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-globaltable-localsecondaryindex.html#cfn-dynamodb-globaltable-localsecondaryindex-projection

Implements

CfnGlobalTable.ILocalSecondaryIndexProperty