Package software.amazon.awscdk.services.dynamodb

Class GlobalSecondaryIndexPropsV2.Builder

java.lang.Object

software.amazon.awscdk.services.dynamodb.GlobalSecondaryIndexPropsV2.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GlobalSecondaryIndexPropsV2>

Enclosing interface:

GlobalSecondaryIndexPropsV2

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

A builder for GlobalSecondaryIndexPropsV2

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GlobalSecondaryIndexPropsV2	build()	Builds the configured instance.
GlobalSecondaryIndexPropsV2.Builder	indexName(String indexName)	Sets the value of SecondaryIndexProps.getIndexName()
GlobalSecondaryIndexPropsV2.Builder	maxReadRequestUnits(Number maxReadRequestUnits)	Sets the value of GlobalSecondaryIndexPropsV2.getMaxReadRequestUnits()
GlobalSecondaryIndexPropsV2.Builder	maxWriteRequestUnits(Number maxWriteRequestUnits)	Sets the value of GlobalSecondaryIndexPropsV2.getMaxWriteRequestUnits()
GlobalSecondaryIndexPropsV2.Builder	nonKeyAttributes(List<String> nonKeyAttributes)	Sets the value of SecondaryIndexProps.getNonKeyAttributes()
GlobalSecondaryIndexPropsV2.Builder	partitionKey(Attribute partitionKey)	Sets the value of GlobalSecondaryIndexPropsV2.getPartitionKey()
GlobalSecondaryIndexPropsV2.Builder	projectionType(ProjectionType projectionType)	Sets the value of SecondaryIndexProps.getProjectionType()
GlobalSecondaryIndexPropsV2.Builder	readCapacity(Capacity readCapacity)	Sets the value of GlobalSecondaryIndexPropsV2.getReadCapacity()
GlobalSecondaryIndexPropsV2.Builder	sortKey(Attribute sortKey)	Sets the value of GlobalSecondaryIndexPropsV2.getSortKey()
GlobalSecondaryIndexPropsV2.Builder	writeCapacity(Capacity writeCapacity)	Sets the value of GlobalSecondaryIndexPropsV2.getWriteCapacity()

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

partitionKey

@Stability(Stable)
public GlobalSecondaryIndexPropsV2.Builder partitionKey(Attribute partitionKey)

Sets the value of GlobalSecondaryIndexPropsV2.getPartitionKey()

Parameters:

partitionKey - Partition key attribute definition. This parameter is required.

Returns:

this

maxReadRequestUnits

@Stability(Stable)
public GlobalSecondaryIndexPropsV2.Builder maxReadRequestUnits(Number maxReadRequestUnits)

Sets the value of GlobalSecondaryIndexPropsV2.getMaxReadRequestUnits()

Parameters:

maxReadRequestUnits - The maximum read request units. Note: This can only be configured if the primary table billing is PAY_PER_REQUEST.

Returns:

this

maxWriteRequestUnits

@Stability(Stable)
public GlobalSecondaryIndexPropsV2.Builder maxWriteRequestUnits(Number maxWriteRequestUnits)

Sets the value of GlobalSecondaryIndexPropsV2.getMaxWriteRequestUnits()

Parameters:

maxWriteRequestUnits - The maximum write request units. Note: This can only be configured if the primary table billing is PAY_PER_REQUEST.

Returns:

this

readCapacity

@Stability(Stable)
public GlobalSecondaryIndexPropsV2.Builder readCapacity(Capacity readCapacity)

Sets the value of GlobalSecondaryIndexPropsV2.getReadCapacity()

Parameters:

readCapacity - The read capacity. Note: This can only be configured if the primary table billing is provisioned.

Returns:

this

sortKey

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

Sets the value of GlobalSecondaryIndexPropsV2.getSortKey()

Parameters:

sortKey - Sort key attribute definition.

Returns:

this

writeCapacity

@Stability(Stable)
public GlobalSecondaryIndexPropsV2.Builder writeCapacity(Capacity writeCapacity)

Sets the value of GlobalSecondaryIndexPropsV2.getWriteCapacity()

Parameters:

writeCapacity - The write capacity. Note: This can only be configured if the primary table billing is provisioned.

Returns:

this

indexName

@Stability(Stable)
public GlobalSecondaryIndexPropsV2.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 GlobalSecondaryIndexPropsV2.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 GlobalSecondaryIndexPropsV2.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 GlobalSecondaryIndexPropsV2 build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of GlobalSecondaryIndexPropsV2

Throws:

NullPointerException - if any required attribute was not provided