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

Class CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing interface:

CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty

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

A builder for CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty	build()	Builds the configured instance.
CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder	indexName(String indexName)	Sets the value of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.getIndexName()
CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder	keySchema(List<? extends Object> keySchema)	Sets the value of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.getKeySchema()
CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder	keySchema(IResolvable keySchema)	Sets the value of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.getKeySchema()
CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder	projection(CfnGlobalTablePropsMixin.ProjectionProperty projection)	Sets the value of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.getProjection()
CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder	projection(IResolvable projection)	Sets the value of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.getProjection()
CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder	readOnDemandThroughputSettings(CfnGlobalTablePropsMixin.ReadOnDemandThroughputSettingsProperty readOnDemandThroughputSettings)	Sets the value of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.getReadOnDemandThroughputSettings()
CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder	readOnDemandThroughputSettings(IResolvable readOnDemandThroughputSettings)	Sets the value of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.getReadOnDemandThroughputSettings()
CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder	readProvisionedThroughputSettings(CfnGlobalTablePropsMixin.GlobalReadProvisionedThroughputSettingsProperty readProvisionedThroughputSettings)	Sets the value of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.getReadProvisionedThroughputSettings()
CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder	readProvisionedThroughputSettings(IResolvable readProvisionedThroughputSettings)	Sets the value of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.getReadProvisionedThroughputSettings()
CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder	warmThroughput(CfnGlobalTablePropsMixin.WarmThroughputProperty warmThroughput)	Sets the value of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.getWarmThroughput()
CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder	warmThroughput(IResolvable warmThroughput)	Sets the value of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.getWarmThroughput()
CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder	writeOnDemandThroughputSettings(CfnGlobalTablePropsMixin.WriteOnDemandThroughputSettingsProperty writeOnDemandThroughputSettings)	Sets the value of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.getWriteOnDemandThroughputSettings()
CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder	writeOnDemandThroughputSettings(IResolvable writeOnDemandThroughputSettings)	Sets the value of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.getWriteOnDemandThroughputSettings()
CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder	writeProvisionedThroughputSettings(CfnGlobalTablePropsMixin.WriteProvisionedThroughputSettingsProperty writeProvisionedThroughputSettings)	Sets the value of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.getWriteProvisionedThroughputSettings()
CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder	writeProvisionedThroughputSettings(IResolvable writeProvisionedThroughputSettings)	Sets the value of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.getWriteProvisionedThroughputSettings()

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 CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder indexName(String indexName)

Sets the value of CfnGlobalTablePropsMixin.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 CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder keySchema(IResolvable keySchema)

Sets the value of CfnGlobalTablePropsMixin.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 CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder keySchema(List<? extends Object> keySchema)

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

projection

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

Sets the value of CfnGlobalTablePropsMixin.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 CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder projection(CfnGlobalTablePropsMixin.ProjectionProperty projection)

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

readOnDemandThroughputSettings

@Stability(Stable)
public CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder readOnDemandThroughputSettings(IResolvable readOnDemandThroughputSettings)

Sets the value of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.getReadOnDemandThroughputSettings()

Parameters:

readOnDemandThroughputSettings - the value to be set.

Returns:

this

readOnDemandThroughputSettings

@Stability(Stable)
public CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder readOnDemandThroughputSettings(CfnGlobalTablePropsMixin.ReadOnDemandThroughputSettingsProperty readOnDemandThroughputSettings)

Sets the value of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.getReadOnDemandThroughputSettings()

Parameters:

readOnDemandThroughputSettings - the value to be set.

Returns:

this

readProvisionedThroughputSettings

@Stability(Stable)
public CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder readProvisionedThroughputSettings(IResolvable readProvisionedThroughputSettings)

Sets the value of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.getReadProvisionedThroughputSettings()

Parameters:

readProvisionedThroughputSettings - the value to be set.

Returns:

this

readProvisionedThroughputSettings

@Stability(Stable)
public CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder readProvisionedThroughputSettings(CfnGlobalTablePropsMixin.GlobalReadProvisionedThroughputSettingsProperty readProvisionedThroughputSettings)

Sets the value of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.getReadProvisionedThroughputSettings()

Parameters:

readProvisionedThroughputSettings - the value to be set.

Returns:

this

warmThroughput

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

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

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

writeOnDemandThroughputSettings

@Stability(Stable)
public CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder writeOnDemandThroughputSettings(IResolvable writeOnDemandThroughputSettings)

Sets the value of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.getWriteOnDemandThroughputSettings()

Parameters:

writeOnDemandThroughputSettings - Sets the write request settings for a global table or a global secondary index. You can only specify this setting if your resource uses the PAY_PER_REQUEST BillingMode .

Returns:

this

writeOnDemandThroughputSettings

@Stability(Stable)
public CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder writeOnDemandThroughputSettings(CfnGlobalTablePropsMixin.WriteOnDemandThroughputSettingsProperty writeOnDemandThroughputSettings)

Sets the value of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.getWriteOnDemandThroughputSettings()

Parameters:

writeOnDemandThroughputSettings - Sets the write request settings for a global table or a global secondary index. You can only specify this setting if your resource uses the PAY_PER_REQUEST BillingMode .

Returns:

this

writeProvisionedThroughputSettings

@Stability(Stable)
public CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder writeProvisionedThroughputSettings(IResolvable writeProvisionedThroughputSettings)

Sets the value of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.getWriteProvisionedThroughputSettings()

Parameters:

writeProvisionedThroughputSettings - Defines write capacity settings for the global secondary index. You must specify a value for this property if the table's BillingMode is PROVISIONED . All replicas will have the same write capacity settings for this global secondary index.

Returns:

this

writeProvisionedThroughputSettings

@Stability(Stable)
public CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.Builder writeProvisionedThroughputSettings(CfnGlobalTablePropsMixin.WriteProvisionedThroughputSettingsProperty writeProvisionedThroughputSettings)

Sets the value of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty.getWriteProvisionedThroughputSettings()

Parameters:

writeProvisionedThroughputSettings - Defines write capacity settings for the global secondary index. You must specify a value for this property if the table's BillingMode is PROVISIONED . All replicas will have the same write capacity settings for this global secondary index.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty

Throws:

NullPointerException - if any required attribute was not provided