Interface ISecondaryIndexProps

Properties for a secondary index.

Namespace: Amazon.CDK.AWS.DynamoDB

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ISecondaryIndexProps

Syntax (vb)

Public Interface 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

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.

Properties

IndexName

The name of the secondary index.

string IndexName { get; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

NonKeyAttributes

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

string[]? NonKeyAttributes { get; }

Property Value

string[]

Remarks

Default: - No additional attributes

ProjectionType

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

ProjectionType? ProjectionType { get; }

Property Value

ProjectionType?

Remarks

Default: ALL