Package software.amazon.awscdk.services.dynamodb

Class LocalSecondaryIndexProps.Builder

java.lang.Object

software.amazon.awscdk.services.dynamodb.LocalSecondaryIndexProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LocalSecondaryIndexProps>

Enclosing interface:

LocalSecondaryIndexProps

@Stability(Stable)
public static final class LocalSecondaryIndexProps.Builder
extends Object
implements software.amazon.jsii.Builder<LocalSecondaryIndexProps>

A builder for LocalSecondaryIndexProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
LocalSecondaryIndexProps	build()	Builds the configured instance.
LocalSecondaryIndexProps.Builder	indexName(String indexName)	Sets the value of SecondaryIndexProps.getIndexName()
LocalSecondaryIndexProps.Builder	nonKeyAttributes(List<String> nonKeyAttributes)	Sets the value of SecondaryIndexProps.getNonKeyAttributes()
LocalSecondaryIndexProps.Builder	projectionType(ProjectionType projectionType)	Sets the value of SecondaryIndexProps.getProjectionType()
LocalSecondaryIndexProps.Builder	sortKey(Attribute sortKey)	Sets the value of LocalSecondaryIndexProps.getSortKey()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

sortKey

@Stability(Stable)
public LocalSecondaryIndexProps.Builder sortKey(Attribute sortKey)

Sets the value of LocalSecondaryIndexProps.getSortKey()

Parameters:

sortKey - The attribute of a sort key for the local secondary index. This parameter is required.

Returns:

this

indexName

@Stability(Stable)
public LocalSecondaryIndexProps.Builder indexName(String indexName)

Sets the value of SecondaryIndexProps.getIndexName()

Parameters:

indexName - The name of the secondary index. This parameter is required.

Returns:

this

nonKeyAttributes

@Stability(Stable)
public LocalSecondaryIndexProps.Builder nonKeyAttributes(List<String> nonKeyAttributes)

Sets the value of SecondaryIndexProps.getNonKeyAttributes()

Parameters:

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

Returns:

this

projectionType

@Stability(Stable)
public LocalSecondaryIndexProps.Builder projectionType(ProjectionType projectionType)

Sets the value of SecondaryIndexProps.getProjectionType()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public LocalSecondaryIndexProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<LocalSecondaryIndexProps>

Returns:

a new instance of LocalSecondaryIndexProps

Throws:

NullPointerException - if any required attribute was not provided