Class SecondaryIndexProps

Properties for a secondary index.

Inheritance

object

SecondaryIndexProps

Implements

ISecondaryIndexProps

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 SecondaryIndexProps : ISecondaryIndexProps

Syntax (vb)

Public Class SecondaryIndexProps 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 for a secondary index.

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()

Properties for a secondary index.

public SecondaryIndexProps()

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
            };

Properties

IndexName

The name of the secondary index.

public string IndexName { get; set; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

NonKeyAttributes

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

public string[]? NonKeyAttributes { get; set; }

Property Value

string[]

Remarks

Default: - No additional attributes

ProjectionType

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

public ProjectionType? ProjectionType { get; set; }

Property Value

ProjectionType?

Remarks

Default: ALL

Implements

ISecondaryIndexProps