Class SecondaryIndexProps

Properties for a secondary index.

Inheritance

System.Object

SecondaryIndexProps

Implements

ISecondaryIndexProps

Namespace: Amazon.CDK.AWS.DynamoDB

Assembly: Amazon.CDK.AWS.DynamoDB.dll

Syntax (csharp)

public class SecondaryIndexProps : Object, ISecondaryIndexProps

Syntax (vb)

Public Class SecondaryIndexProps
    Inherits Object
    Implements ISecondaryIndexProps

Remarks

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 secondaryIndexProps = new SecondaryIndexProps {
    IndexName = "indexName",

    // the properties below are optional
    NonKeyAttributes = new [] { "nonKeyAttributes" },
    ProjectionType = ProjectionType.KEYS_ONLY
};

Synopsis

Constructors

SecondaryIndexProps()

Properties

IndexName	The name of the secondary index.
NonKeyAttributes	The non-key attributes that are projected into the secondary index.
ProjectionType	The set of attributes that are projected into the secondary index.

Constructors

SecondaryIndexProps()

public SecondaryIndexProps()

Properties

IndexName

The name of the secondary index.

public string IndexName { get; set; }

Property Value

System.String

NonKeyAttributes

The non-key attributes that are projected into the secondary index.

public string[] NonKeyAttributes { get; set; }

Property Value

System.String[]

Remarks

Default: - No additional attributes

ProjectionType

The set of attributes that are projected into the secondary index.

public Nullable<ProjectionType> ProjectionType { get; set; }

Property Value

System.Nullable<ProjectionType>

Remarks

Default: ALL

Implements

ISecondaryIndexProps