software.amazon.awscdk.services.dynamodb

Interface SecondaryIndexProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

GlobalSecondaryIndexProps, LocalSecondaryIndexProps

All Known Implementing Classes:

GlobalSecondaryIndexProps.Jsii$Proxy, LocalSecondaryIndexProps.Jsii$Proxy, SecondaryIndexProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:01:06.474Z")
 @Stability(value=Experimental)
public interface SecondaryIndexProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for a secondary index.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static SecondaryIndexProps.Builder	builder()
String	getIndexName() (experimental) The name of the secondary index.
default List<String>	getNonKeyAttributes() (experimental) The non-key attributes that are projected into the secondary index.
default ProjectionType	getProjectionType() (experimental) The set of attributes that are projected into the secondary index.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getIndexName

@Stability(value=Experimental)
 @NotNull
String getIndexName()

(experimental) The name of the secondary index.

getNonKeyAttributes

@Stability(value=Experimental)
 @Nullable
default List<String> getNonKeyAttributes()

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

Default: - No additional attributes

getProjectionType

@Stability(value=Experimental)
 @Nullable
default ProjectionType getProjectionType()

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

Default: ALL

builder

@Stability(value=Experimental)
static SecondaryIndexProps.Builder builder()

Returns:

a SecondaryIndexProps.Builder of SecondaryIndexProps