- All Superinterfaces:
- All Known Implementing Classes:
- Enclosing class:
A local secondary index can only be created when its parent table is created.
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.dynamodb.*; LocalSecondaryIndexProperty localSecondaryIndexProperty = LocalSecondaryIndexProperty.builder() .indexName("indexName") .keySchema(List.of(KeySchemaProperty.builder() .attributeName("attributeName") .keyType("keyType") .build())) .projection(ProjectionProperty.builder() .nonKeyAttributes(List.of("nonKeyAttributes")) .projectionType("projectionType") .build()) .build();
Nested Class SummaryModifier and TypeInterfaceDescription
static final classA builder for
static final classAn implementation for
Method SummaryModifier and TypeMethodDescription
builder()The name of the local secondary index.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 .Represents attributes that are copied (projected) from the table into the local secondary index.
Methods inherited from interface software.amazon.jsii.JsiiSerializable
getIndexName@Stability(Stable) @NotNull String getIndexName()The name of the local secondary index.
The name must be unique among all other indexes on this table.
getKeySchema@Stability(Stable) @NotNull Object getKeySchema()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 .
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 range attribute . 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.
getProjection@Stability(Stable) @NotNull Object getProjection()Represents attributes that are copied (projected) from the table into the local secondary index.
These are in addition to the primary key attributes and index key attributes, which are automatically projected.
builder@Stability(Stable) static CfnGlobalTable.LocalSecondaryIndexProperty.Builder builder()