Package software.amazon.awscdk.cfnpropertymixins.services.dynamodb

Class CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.dynamodb.CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTablePropsMixin.GlobalSecondaryIndexProperty>

Enclosing interface:

CfnTablePropsMixin.GlobalSecondaryIndexProperty

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

A builder for CfnTablePropsMixin.GlobalSecondaryIndexProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnTablePropsMixin.GlobalSecondaryIndexProperty	build()	Builds the configured instance.
CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder	contributorInsightsSpecification(CfnTablePropsMixin.ContributorInsightsSpecificationProperty contributorInsightsSpecification)	Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getContributorInsightsSpecification()
CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder	contributorInsightsSpecification(IResolvable contributorInsightsSpecification)	Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getContributorInsightsSpecification()
CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder	indexName(String indexName)	Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getIndexName()
CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder	keySchema(List<? extends Object> keySchema)	Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getKeySchema()
CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder	keySchema(IResolvable keySchema)	Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getKeySchema()
CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder	onDemandThroughput(CfnTablePropsMixin.OnDemandThroughputProperty onDemandThroughput)	Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getOnDemandThroughput()
CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder	onDemandThroughput(IResolvable onDemandThroughput)	Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getOnDemandThroughput()
CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder	projection(CfnTablePropsMixin.ProjectionProperty projection)	Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getProjection()
CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder	projection(IResolvable projection)	Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getProjection()
CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder	provisionedThroughput(CfnTablePropsMixin.ProvisionedThroughputProperty provisionedThroughput)	Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getProvisionedThroughput()
CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder	provisionedThroughput(IResolvable provisionedThroughput)	Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getProvisionedThroughput()
CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder	warmThroughput(CfnTablePropsMixin.WarmThroughputProperty warmThroughput)	Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getWarmThroughput()
CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder	warmThroughput(IResolvable warmThroughput)	Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getWarmThroughput()

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

contributorInsightsSpecification

@Stability(Stable)
public CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder contributorInsightsSpecification(IResolvable contributorInsightsSpecification)

Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getContributorInsightsSpecification()

Parameters:

contributorInsightsSpecification - The settings used to specify whether to enable CloudWatch Contributor Insights for the global table and define which events to monitor.

Returns:

this

contributorInsightsSpecification

@Stability(Stable)
public CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder contributorInsightsSpecification(CfnTablePropsMixin.ContributorInsightsSpecificationProperty contributorInsightsSpecification)

Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getContributorInsightsSpecification()

Parameters:

contributorInsightsSpecification - The settings used to specify whether to enable CloudWatch Contributor Insights for the global table and define which events to monitor.

Returns:

this

indexName

@Stability(Stable)
public CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder indexName(String indexName)

Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getIndexName()

Parameters:

indexName - The name of the global secondary index. The name must be unique among all other indexes on this table.

Returns:

this

keySchema

@Stability(Stable)
public CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder keySchema(IResolvable keySchema)

Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getKeySchema()

Parameters:

keySchema - The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: - HASH - partition key - RANGE - sort key > The partition key of an item is also known as its hash attribute . The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute . The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

Returns:

this

keySchema

@Stability(Stable)
public CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder keySchema(List<? extends Object> keySchema)

Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getKeySchema()

Parameters:

keySchema - The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: - HASH - partition key - RANGE - sort key > The partition key of an item is also known as its hash attribute . The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute . The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

Returns:

this

onDemandThroughput

@Stability(Stable)
public CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder onDemandThroughput(IResolvable onDemandThroughput)

Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getOnDemandThroughput()

Parameters:

onDemandThroughput - The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits , MaxWriteRequestUnits , or both. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.

Returns:

this

onDemandThroughput

@Stability(Stable)
public CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder onDemandThroughput(CfnTablePropsMixin.OnDemandThroughputProperty onDemandThroughput)

Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getOnDemandThroughput()

Parameters:

onDemandThroughput - The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits , MaxWriteRequestUnits , or both. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.

Returns:

this

projection

@Stability(Stable)
public CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder projection(IResolvable projection)

Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getProjection()

Parameters:

projection - Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

Returns:

this

projection

@Stability(Stable)
public CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder projection(CfnTablePropsMixin.ProjectionProperty projection)

Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getProjection()

Parameters:

projection - Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

Returns:

this

provisionedThroughput

@Stability(Stable)
public CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder provisionedThroughput(IResolvable provisionedThroughput)

Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getProvisionedThroughput()

Parameters:

provisionedThroughput - Represents the provisioned throughput settings for the specified global secondary index. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide .

Returns:

this

provisionedThroughput

@Stability(Stable)
public CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder provisionedThroughput(CfnTablePropsMixin.ProvisionedThroughputProperty provisionedThroughput)

Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getProvisionedThroughput()

Parameters:

provisionedThroughput - Represents the provisioned throughput settings for the specified global secondary index. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide .

Returns:

this

warmThroughput

@Stability(Stable)
public CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder warmThroughput(IResolvable warmThroughput)

Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getWarmThroughput()

Parameters:

warmThroughput - Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify ReadUnitsPerSecond , WriteUnitsPerSecond , or both.

Returns:

this

warmThroughput

@Stability(Stable)
public CfnTablePropsMixin.GlobalSecondaryIndexProperty.Builder warmThroughput(CfnTablePropsMixin.WarmThroughputProperty warmThroughput)

Sets the value of CfnTablePropsMixin.GlobalSecondaryIndexProperty.getWarmThroughput()

Parameters:

warmThroughput - Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify ReadUnitsPerSecond , WriteUnitsPerSecond , or both.

Returns:

this

build

@Stability(Stable)
public CfnTablePropsMixin.GlobalSecondaryIndexProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnTablePropsMixin.GlobalSecondaryIndexProperty>

Returns:

a new instance of CfnTablePropsMixin.GlobalSecondaryIndexProperty

Throws:

NullPointerException - if any required attribute was not provided