Package software.amazon.awscdk.services.dynamodb

Class KeySchema.Builder

java.lang.Object

software.amazon.awscdk.services.dynamodb.KeySchema.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<KeySchema>

Enclosing interface:

KeySchema

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

A builder for KeySchema

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
KeySchema	build()	Builds the configured instance.
KeySchema.Builder	partitionKeys(List<? extends Attribute> partitionKeys)	Sets the value of KeySchema.getPartitionKeys()
KeySchema.Builder	sortKeys(List<? extends Attribute> sortKeys)	Sets the value of KeySchema.getSortKeys()

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

partitionKeys

@Stability(Stable)
public KeySchema.Builder partitionKeys(List<? extends Attribute> partitionKeys)

Sets the value of KeySchema.getPartitionKeys()

Parameters:

partitionKeys - Partition key definition. This parameter is required. This array has at least one, but potentially multiple entries. Together, they form the partition key.

Returns:

this

sortKeys

@Stability(Stable)
public KeySchema.Builder sortKeys(List<? extends Attribute> sortKeys)

Sets the value of KeySchema.getSortKeys()

Parameters:

sortKeys - Sort key definition. This parameter is required. This array has zero or more entries. Together, they form the sort key.

Returns:

this

build

@Stability(Stable)
public KeySchema build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of KeySchema

Throws:

NullPointerException - if any required attribute was not provided