software.amazon.awscdk.services.dynamodb

Class GlobalSecondaryIndexProps.Builder

java.lang.Object

software.amazon.awscdk.services.dynamodb.GlobalSecondaryIndexProps.Builder

Enclosing interface:

GlobalSecondaryIndexProps

@Stability(value=Experimental)
public static final class GlobalSecondaryIndexProps.Builder
extends Object

A builder for GlobalSecondaryIndexProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
GlobalSecondaryIndexProps	build() Builds the configured instance.
GlobalSecondaryIndexProps.Builder	withIndexName(String value) Sets the value of IndexName
GlobalSecondaryIndexProps.Builder	withNonKeyAttributes(List<String> value) Sets the value of NonKeyAttributes
GlobalSecondaryIndexProps.Builder	withPartitionKey(Attribute value) Sets the value of PartitionKey
GlobalSecondaryIndexProps.Builder	withProjectionType(ProjectionType value) Sets the value of ProjectionType
GlobalSecondaryIndexProps.Builder	withReadCapacity(Number value) Sets the value of ReadCapacity
GlobalSecondaryIndexProps.Builder	withSortKey(Attribute value) Sets the value of SortKey
GlobalSecondaryIndexProps.Builder	withWriteCapacity(Number value) Sets the value of WriteCapacity

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

withPartitionKey

@Stability(value=Experimental)
public GlobalSecondaryIndexProps.Builder withPartitionKey(Attribute value)

Sets the value of PartitionKey

Parameters:

value - The attribute of a partition key for the global secondary index.

Returns:

this

withReadCapacity

@Stability(value=Experimental)
public GlobalSecondaryIndexProps.Builder withReadCapacity(@Nullable
                                                                                         Number value)

Sets the value of ReadCapacity

Parameters:

value - The read capacity for the global secondary index.

Returns:

this

withSortKey

@Stability(value=Experimental)
public GlobalSecondaryIndexProps.Builder withSortKey(@Nullable
                                                                                    Attribute value)

Sets the value of SortKey

Parameters:

value - The attribute of a sort key for the global secondary index.

Returns:

this

withWriteCapacity

@Stability(value=Experimental)
public GlobalSecondaryIndexProps.Builder withWriteCapacity(@Nullable
                                                                                          Number value)

Sets the value of WriteCapacity

Parameters:

value - The write capacity for the global secondary index.

Returns:

this

withIndexName

@Stability(value=Experimental)
public GlobalSecondaryIndexProps.Builder withIndexName(String value)

Sets the value of IndexName

Parameters:

value - The name of the secondary index.

Returns:

this

withNonKeyAttributes

@Stability(value=Experimental)
public GlobalSecondaryIndexProps.Builder withNonKeyAttributes(@Nullable
                                                                                             List<String> value)

Sets the value of NonKeyAttributes

Parameters:

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

Returns:

this

withProjectionType

@Stability(value=Experimental)
public GlobalSecondaryIndexProps.Builder withProjectionType(@Nullable
                                                                                           ProjectionType value)

Sets the value of ProjectionType

Parameters:

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

Returns:

this

build

@Stability(value=Experimental)
public GlobalSecondaryIndexProps build()

Builds the configured instance.

Returns:

a new instance of GlobalSecondaryIndexProps

Throws:

NullPointerException - if any required attribute was not provided