Package software.amazon.awscdk.services.dynamodb

Interface SecondaryIndexProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

GlobalSecondaryIndexProps, GlobalSecondaryIndexPropsV2, LocalSecondaryIndexProps

All Known Implementing Classes:

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

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-14T03:24:56.613Z")
@Stability(Stable)
public interface SecondaryIndexProps
extends software.amazon.jsii.JsiiSerializable

Properties for a 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.*;
 SecondaryIndexProps secondaryIndexProps = SecondaryIndexProps.builder()
         .indexName("indexName")
         // the properties below are optional
         .nonKeyAttributes(List.of("nonKeyAttributes"))
         .projectionType(ProjectionType.KEYS_ONLY)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIndexName

@Stability(Stable)
@NotNull
String getIndexName()

The name of the secondary index.

getNonKeyAttributes

@Stability(Stable)
@Nullable
default List<String> getNonKeyAttributes()

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

Default: - No additional attributes

getProjectionType

@Stability(Stable)
@Nullable
default ProjectionType getProjectionType()

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

Default: ALL

builder

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

Returns:

a SecondaryIndexProps.Builder of SecondaryIndexProps