Package software.amazon.awscdk.services.dynamodb

Class GlobalSecondaryIndexProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<GlobalSecondaryIndexProps>

Enclosing interface:

GlobalSecondaryIndexProps

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

A builder for GlobalSecondaryIndexProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GlobalSecondaryIndexProps	build()	Builds the configured instance.
GlobalSecondaryIndexProps.Builder	contributorInsightsEnabled(Boolean contributorInsightsEnabled)	Deprecated. use `contributorInsightsSpecification` instead
GlobalSecondaryIndexProps.Builder	contributorInsightsSpecification(ContributorInsightsSpecification contributorInsightsSpecification)	Sets the value of GlobalSecondaryIndexProps.getContributorInsightsSpecification()
GlobalSecondaryIndexProps.Builder	indexName(String indexName)	Sets the value of SecondaryIndexProps.getIndexName()
GlobalSecondaryIndexProps.Builder	maxReadRequestUnits(Number maxReadRequestUnits)	Sets the value of GlobalSecondaryIndexProps.getMaxReadRequestUnits()
GlobalSecondaryIndexProps.Builder	maxWriteRequestUnits(Number maxWriteRequestUnits)	Sets the value of GlobalSecondaryIndexProps.getMaxWriteRequestUnits()
GlobalSecondaryIndexProps.Builder	nonKeyAttributes(List<String> nonKeyAttributes)	Sets the value of SecondaryIndexProps.getNonKeyAttributes()
GlobalSecondaryIndexProps.Builder	partitionKey(Attribute partitionKey)	Sets the value of SchemaOptions.getPartitionKey()
GlobalSecondaryIndexProps.Builder	partitionKeys(List<? extends Attribute> partitionKeys)	Sets the value of GlobalSecondaryIndexProps.getPartitionKeys()
GlobalSecondaryIndexProps.Builder	projectionType(ProjectionType projectionType)	Sets the value of SecondaryIndexProps.getProjectionType()
GlobalSecondaryIndexProps.Builder	readCapacity(Number readCapacity)	Sets the value of GlobalSecondaryIndexProps.getReadCapacity()
GlobalSecondaryIndexProps.Builder	sortKey(Attribute sortKey)	Sets the value of SchemaOptions.getSortKey()
GlobalSecondaryIndexProps.Builder	sortKeys(List<? extends Attribute> sortKeys)	Sets the value of GlobalSecondaryIndexProps.getSortKeys()
GlobalSecondaryIndexProps.Builder	warmThroughput(WarmThroughput warmThroughput)	Sets the value of GlobalSecondaryIndexProps.getWarmThroughput()
GlobalSecondaryIndexProps.Builder	writeCapacity(Number writeCapacity)	Sets the value of GlobalSecondaryIndexProps.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

contributorInsightsEnabled

@Stability(Deprecated)
@Deprecated
public GlobalSecondaryIndexProps.Builder contributorInsightsEnabled(Boolean contributorInsightsEnabled)

Deprecated.

use `contributorInsightsSpecification` instead

Sets the value of GlobalSecondaryIndexProps.getContributorInsightsEnabled()

Parameters:

contributorInsightsEnabled - Whether CloudWatch contributor insights is enabled for the specified global secondary index.

Returns:

this

contributorInsightsSpecification

@Stability(Stable)
public GlobalSecondaryIndexProps.Builder contributorInsightsSpecification(ContributorInsightsSpecification contributorInsightsSpecification)

Sets the value of GlobalSecondaryIndexProps.getContributorInsightsSpecification()

Parameters:

contributorInsightsSpecification - Whether CloudWatch contributor insights is enabled and what mode is selected.

Returns:

this

maxReadRequestUnits

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

Sets the value of GlobalSecondaryIndexProps.getMaxReadRequestUnits()

Parameters:

maxReadRequestUnits - The maximum read request units for the global secondary index. Can only be provided if table billingMode is PAY_PER_REQUEST.

Returns:

this

maxWriteRequestUnits

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

Sets the value of GlobalSecondaryIndexProps.getMaxWriteRequestUnits()

Parameters:

maxWriteRequestUnits - The maximum write request units for the global secondary index. Can only be provided if table billingMode is PAY_PER_REQUEST.

Returns:

this

partitionKeys

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

Sets the value of GlobalSecondaryIndexProps.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 GlobalSecondaryIndexProps.Builder readCapacity(Number readCapacity)

Sets the value of GlobalSecondaryIndexProps.getReadCapacity()

Parameters:

readCapacity - The read capacity for the global secondary index. Can only be provided if table billingMode is Provisioned or undefined.

Returns:

this

sortKeys

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

Sets the value of GlobalSecondaryIndexProps.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 GlobalSecondaryIndexProps.Builder warmThroughput(WarmThroughput warmThroughput)

Sets the value of GlobalSecondaryIndexProps.getWarmThroughput()

Parameters:

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

Returns:

this

writeCapacity

@Stability(Stable)
public GlobalSecondaryIndexProps.Builder writeCapacity(Number writeCapacity)

Sets the value of GlobalSecondaryIndexProps.getWriteCapacity()

Parameters:

writeCapacity - The write capacity for the global secondary index. Can only be provided if table billingMode is Provisioned or undefined.

Returns:

this

indexName

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

partitionKey

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

Sets the value of SchemaOptions.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

sortKey

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

Sets the value of SchemaOptions.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

build

@Stability(Stable)
public GlobalSecondaryIndexProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of GlobalSecondaryIndexProps

Throws:

NullPointerException - if any required attribute was not provided