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	partitionKeys(List<? extends Attribute> partitionKeys)	Sets the value of GlobalSecondaryIndexPropsV2.getPartitionKeys()
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	sortKeys(List<? extends Attribute> sortKeys)	Sets the value of GlobalSecondaryIndexPropsV2.getSortKeys()
GlobalSecondaryIndexPropsV2.Builder	warmThroughput(WarmThroughput warmThroughput)	Sets the value of GlobalSecondaryIndexPropsV2.getWarmThroughput()
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

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

partitionKey

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

Sets the value of GlobalSecondaryIndexPropsV2.getPartitionKey()

Parameters:

partitionKey - Partition key attribute definition. If a single field forms the partition key, you can use this field. Use the partitionKeys field if the partition key is a multi-attribute key (consists of multiple fields).

Returns:

this

partitionKeys

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

Sets the value of GlobalSecondaryIndexPropsV2.getPartitionKeys()

Parameters:

partitionKeys - Multi-attribute partition key. If a single field forms the partition key, you can use either partitionKey or partitionKeys to specify the partition key. Exactly one of these must be specified.

You must use partitionKeys field if the partition key is a multi-attribute key (consists of multiple fields).

NOTE: although the name of this field makes it sound like it creates multiple keys, it does not. It defines a single key that consists of of multiple fields.

The order of fields is not important.

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. If a single field forms the sort key, you can use this field. Use the sortKeys field if the sort key is a multi-attribute key (consists of multiple fields).

Returns:

this

sortKeys

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

Sets the value of GlobalSecondaryIndexPropsV2.getSortKeys()

Parameters:

sortKeys - Multi-attribute sort key. If a single field forms the sort key, you can use either sortKey or sortKeys to specify the sort key. At most one of these may be specified.

You must use sortKeys field if the sort key is a multi-attribute key (consists of multiple fields).

NOTE: although the name of this field makes it sound like it creates multiple keys, it does not. It defines a single key that consists of of multiple fields at the same time.

NOTE: The order of fields is important!

Returns:

this

warmThroughput

@Stability(Stable)
public GlobalSecondaryIndexPropsV2.Builder warmThroughput(WarmThroughput warmThroughput)

Sets the value of GlobalSecondaryIndexPropsV2.getWarmThroughput()

Parameters:

warmThroughput - The warm throughput configuration for the global secondary index.

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