Package software.amazon.awscdk.services.dynamodb

Class CfnTable.GlobalSecondaryIndexProperty.Builder

java.lang.Object

software.amazon.awscdk.services.dynamodb.CfnTable.GlobalSecondaryIndexProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnTable.GlobalSecondaryIndexProperty

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

A builder for CfnTable.GlobalSecondaryIndexProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

indexName

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

Sets the value of CfnTable.GlobalSecondaryIndexProperty.getIndexName()

Parameters:

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

Returns:

this

keySchema

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

Sets the value of CfnTable.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 . This parameter is required. 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 CfnTable.GlobalSecondaryIndexProperty.Builder keySchema(List<? extends Object> keySchema)

Sets the value of CfnTable.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 . This parameter is required. 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

projection

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

Sets the value of CfnTable.GlobalSecondaryIndexProperty.getProjection()

Parameters:

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

Returns:

this

projection

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

Sets the value of CfnTable.GlobalSecondaryIndexProperty.getProjection()

Parameters:

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

Returns:

this

contributorInsightsSpecification

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

Sets the value of CfnTable.GlobalSecondaryIndexProperty.getContributorInsightsSpecification()

Parameters:

contributorInsightsSpecification - The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index.

Returns:

this

contributorInsightsSpecification

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

Sets the value of CfnTable.GlobalSecondaryIndexProperty.getContributorInsightsSpecification()

Parameters:

contributorInsightsSpecification - The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index.

Returns:

this

onDemandThroughput

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

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

Returns:

this

onDemandThroughput

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

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

Returns:

this

provisionedThroughput

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

Sets the value of CfnTable.GlobalSecondaryIndexProperty.getProvisionedThroughput()

Parameters:

provisionedThroughput - Represents the provisioned throughput settings for the specified global secondary index. 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 CfnTable.GlobalSecondaryIndexProperty.Builder provisionedThroughput(CfnTable.ProvisionedThroughputProperty provisionedThroughput)

Sets the value of CfnTable.GlobalSecondaryIndexProperty.getProvisionedThroughput()

Parameters:

provisionedThroughput - Represents the provisioned throughput settings for the specified global secondary index. 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 CfnTable.GlobalSecondaryIndexProperty.Builder warmThroughput(IResolvable warmThroughput)

Sets the value of CfnTable.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 CfnTable.GlobalSecondaryIndexProperty.Builder warmThroughput(CfnTable.WarmThroughputProperty warmThroughput)

Sets the value of CfnTable.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 CfnTable.GlobalSecondaryIndexProperty build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnTable.GlobalSecondaryIndexProperty

Throws:

NullPointerException - if any required attribute was not provided