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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.078Z")
 @Stability(value=Stable)
public interface LocalSecondaryIndexProps
extends software.amazon.jsii.JsiiSerializable, SecondaryIndexProps

Properties for a local secondary index.

Example:

 // 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.*;
 LocalSecondaryIndexProps localSecondaryIndexProps = LocalSecondaryIndexProps.builder()
         .indexName("indexName")
         .sortKey(Attribute.builder()
                 .name("name")
                 .type(AttributeType.BINARY)
                 .build())
         // the properties below are optional
         .nonKeyAttributes(List.of("nonKeyAttributes"))
         .projectionType(ProjectionType.KEYS_ONLY)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

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

getIndexName, getNonKeyAttributes, getProjectionType

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getSortKey

@Stability(value=Stable)
 @NotNull
Attribute getSortKey()

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

builder

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

Specified by:

builder in interface SecondaryIndexProps

Returns:

a LocalSecondaryIndexProps.Builder of LocalSecondaryIndexProps