Interface LocalSecondaryIndexProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable,SecondaryIndexProps
- All Known Implementing Classes:
LocalSecondaryIndexProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:42.286Z")
@Stability(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 ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forLocalSecondaryIndexPropsstatic final classAn implementation forLocalSecondaryIndexProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()The attribute of a sort key for the local secondary index.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJsonMethods inherited from interface software.amazon.awscdk.services.dynamodb.SecondaryIndexProps
getIndexName, getNonKeyAttributes, getProjectionType
-
Method Details
-
getSortKey
The attribute of a sort key for the local secondary index. -
builder
- Returns:
- a
LocalSecondaryIndexProps.BuilderofLocalSecondaryIndexProps
-