Package software.amazon.awscdk.services.dynamodb

Class CfnGlobalTable.CapacityAutoScalingSettingsProperty.Builder

java.lang.Object

software.amazon.awscdk.services.dynamodb.CfnGlobalTable.CapacityAutoScalingSettingsProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGlobalTable.CapacityAutoScalingSettingsProperty>

Enclosing interface:

CfnGlobalTable.CapacityAutoScalingSettingsProperty

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

A builder for CfnGlobalTable.CapacityAutoScalingSettingsProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnGlobalTable.CapacityAutoScalingSettingsProperty	build()	Builds the configured instance.
CfnGlobalTable.CapacityAutoScalingSettingsProperty.Builder	maxCapacity(Number maxCapacity)	Sets the value of CfnGlobalTable.CapacityAutoScalingSettingsProperty.getMaxCapacity()
CfnGlobalTable.CapacityAutoScalingSettingsProperty.Builder	minCapacity(Number minCapacity)	Sets the value of CfnGlobalTable.CapacityAutoScalingSettingsProperty.getMinCapacity()
CfnGlobalTable.CapacityAutoScalingSettingsProperty.Builder	seedCapacity(Number seedCapacity)	Sets the value of CfnGlobalTable.CapacityAutoScalingSettingsProperty.getSeedCapacity()
CfnGlobalTable.CapacityAutoScalingSettingsProperty.Builder	targetTrackingScalingPolicyConfiguration(IResolvable targetTrackingScalingPolicyConfiguration)	Sets the value of CfnGlobalTable.CapacityAutoScalingSettingsProperty.getTargetTrackingScalingPolicyConfiguration()
CfnGlobalTable.CapacityAutoScalingSettingsProperty.Builder	targetTrackingScalingPolicyConfiguration(CfnGlobalTable.TargetTrackingScalingPolicyConfigurationProperty targetTrackingScalingPolicyConfiguration)	Sets the value of CfnGlobalTable.CapacityAutoScalingSettingsProperty.getTargetTrackingScalingPolicyConfiguration()

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

maxCapacity

@Stability(Stable)
public CfnGlobalTable.CapacityAutoScalingSettingsProperty.Builder maxCapacity(Number maxCapacity)

Sets the value of CfnGlobalTable.CapacityAutoScalingSettingsProperty.getMaxCapacity()

Parameters:

maxCapacity - The maximum provisioned capacity units for the global table. This parameter is required.

Returns:

this

minCapacity

@Stability(Stable)
public CfnGlobalTable.CapacityAutoScalingSettingsProperty.Builder minCapacity(Number minCapacity)

Sets the value of CfnGlobalTable.CapacityAutoScalingSettingsProperty.getMinCapacity()

Parameters:

minCapacity - The minimum provisioned capacity units for the global table. This parameter is required.

Returns:

this

targetTrackingScalingPolicyConfiguration

@Stability(Stable)
public CfnGlobalTable.CapacityAutoScalingSettingsProperty.Builder targetTrackingScalingPolicyConfiguration(IResolvable targetTrackingScalingPolicyConfiguration)

Sets the value of CfnGlobalTable.CapacityAutoScalingSettingsProperty.getTargetTrackingScalingPolicyConfiguration()

Parameters:

targetTrackingScalingPolicyConfiguration - Defines a target tracking scaling policy. This parameter is required.

Returns:

this

targetTrackingScalingPolicyConfiguration

@Stability(Stable)
public CfnGlobalTable.CapacityAutoScalingSettingsProperty.Builder targetTrackingScalingPolicyConfiguration(CfnGlobalTable.TargetTrackingScalingPolicyConfigurationProperty targetTrackingScalingPolicyConfiguration)

Sets the value of CfnGlobalTable.CapacityAutoScalingSettingsProperty.getTargetTrackingScalingPolicyConfiguration()

Parameters:

targetTrackingScalingPolicyConfiguration - Defines a target tracking scaling policy. This parameter is required.

Returns:

this

seedCapacity

@Stability(Stable)
public CfnGlobalTable.CapacityAutoScalingSettingsProperty.Builder seedCapacity(Number seedCapacity)

Sets the value of CfnGlobalTable.CapacityAutoScalingSettingsProperty.getSeedCapacity()

Parameters:

seedCapacity - When switching billing mode from PAY_PER_REQUEST to PROVISIONED , DynamoDB requires you to specify read and write capacity unit values for the table and for each global secondary index. These values will be applied to all replicas. The table will use these provisioned values until CloudFormation creates the autoscaling policies you configured in your template. CloudFormation cannot determine what capacity the table and its global secondary indexes will require in this time period, since they are application-dependent.

If you want to switch a table's billing mode from PAY_PER_REQUEST to PROVISIONED , you must specify a value for this property for each autoscaled resource. If you specify different values for the same resource in different regions, CloudFormation will use the highest value found in either the SeedCapacity or ReadCapacityUnits properties. For example, if your global secondary index myGSI has a SeedCapacity of 10 in us-east-1 and a fixed ReadCapacityUnits of 20 in eu-west-1, CloudFormation will initially set the read capacity for myGSI to 20. Note that if you disable ScaleIn for myGSI in us-east-1, its read capacity units might not be set back to 10.

You must also specify a value for SeedCapacity when you plan to switch a table's billing mode from PROVISIONED to PAY_PER_REQUEST , because CloudFormation might need to roll back the operation (reverting the billing mode to PROVISIONED ) and this cannot succeed without specifying a value for SeedCapacity .

Returns:

this

build

@Stability(Stable)
public CfnGlobalTable.CapacityAutoScalingSettingsProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnGlobalTable.CapacityAutoScalingSettingsProperty>

Returns:

a new instance of CfnGlobalTable.CapacityAutoScalingSettingsProperty

Throws:

NullPointerException - if any required attribute was not provided