Package software.amazon.awscdk.services.dynamodb

Interface LocalSecondaryIndexProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, SecondaryIndexProps

All Known Implementing Classes:

LocalSecondaryIndexProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:35.282Z")
@Stability(Stable)
public interface LocalSecondaryIndexProps
extends software.amazon.jsii.JsiiSerializable, SecondaryIndexProps

Properties for a local secondary index.

Example:

 TableV2 table = TableV2.Builder.create(this, "Table")
         .partitionKey(Attribute.builder().name("pk").type(AttributeType.STRING).build())
         .sortKey(Attribute.builder().name("sk").type(AttributeType.NUMBER).build())
         .localSecondaryIndexes(List.of(LocalSecondaryIndexProps.builder()
                 .indexName("lsi1")
                 .sortKey(Attribute.builder().name("sk").type(AttributeType.NUMBER).build())
                 .build()))
         .build();
 table.addLocalSecondaryIndex(LocalSecondaryIndexProps.builder()
         .indexName("lsi2")
         .sortKey(Attribute.builder().name("sk").type(AttributeType.NUMBER).build())
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	LocalSecondaryIndexProps.Builder	A builder for LocalSecondaryIndexProps
static final class	LocalSecondaryIndexProps.Jsii$Proxy	An implementation for LocalSecondaryIndexProps

Method Summary

Modifier and Type	Method	Description
static LocalSecondaryIndexProps.Builder	builder()
Attribute	getSortKey()	The attribute of a sort key for the local secondary index.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.dynamodb.SecondaryIndexProps

getIndexName, getNonKeyAttributes, getProjectionType

Method Details

getSortKey

@Stability(Stable)
@NotNull
Attribute getSortKey()

The attribute of a sort key for the local secondary index.

builder

@Stability(Stable)
static LocalSecondaryIndexProps.Builder builder()

Returns:

a LocalSecondaryIndexProps.Builder of LocalSecondaryIndexProps