Package software.amazon.awscdk.mixins.preview.services.dynamodb.mixins

Interface CfnGlobalTablePropsMixin.CapacityAutoScalingSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGlobalTablePropsMixin.CapacityAutoScalingSettingsProperty.Jsii$Proxy

Enclosing class:

CfnGlobalTablePropsMixin

@Stability(Stable)
public static interface CfnGlobalTablePropsMixin.CapacityAutoScalingSettingsProperty
extends software.amazon.jsii.JsiiSerializable

Configures a scalable target and an autoscaling policy for a table or global secondary index's read or write capacity.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.mixins.preview.services.dynamodb.mixins.*;
 CapacityAutoScalingSettingsProperty capacityAutoScalingSettingsProperty = CapacityAutoScalingSettingsProperty.builder()
         .maxCapacity(123)
         .minCapacity(123)
         .seedCapacity(123)
         .targetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfigurationProperty.builder()
                 .disableScaleIn(false)
                 .scaleInCooldown(123)
                 .scaleOutCooldown(123)
                 .targetValue(123)
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-capacityautoscalingsettings.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGlobalTablePropsMixin.CapacityAutoScalingSettingsProperty.Builder	A builder for CfnGlobalTablePropsMixin.CapacityAutoScalingSettingsProperty
static final class	CfnGlobalTablePropsMixin.CapacityAutoScalingSettingsProperty.Jsii$Proxy	An implementation for CfnGlobalTablePropsMixin.CapacityAutoScalingSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnGlobalTablePropsMixin.CapacityAutoScalingSettingsProperty.Builder	builder()
default Number	getMaxCapacity()	The maximum provisioned capacity units for the global table.
default Number	getMinCapacity()	The minimum provisioned capacity units for the global table.
default Number	getSeedCapacity()	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.
default Object	getTargetTrackingScalingPolicyConfiguration()	Defines a target tracking scaling policy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMaxCapacity

@Stability(Stable)
@Nullable
default Number getMaxCapacity()

The maximum provisioned capacity units for the global table.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-capacityautoscalingsettings.html#cfn-dynamodb-globaltable-capacityautoscalingsettings-maxcapacity

getMinCapacity

@Stability(Stable)
@Nullable
default Number getMinCapacity()

The minimum provisioned capacity units for the global table.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-capacityautoscalingsettings.html#cfn-dynamodb-globaltable-capacityautoscalingsettings-mincapacity

getSeedCapacity

@Stability(Stable)
@Nullable
default Number getSeedCapacity()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-capacityautoscalingsettings.html#cfn-dynamodb-globaltable-capacityautoscalingsettings-seedcapacity

getTargetTrackingScalingPolicyConfiguration

@Stability(Stable)
@Nullable
default Object getTargetTrackingScalingPolicyConfiguration()

Defines a target tracking scaling policy.

Returns union: either IResolvable or CfnGlobalTablePropsMixin.TargetTrackingScalingPolicyConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-capacityautoscalingsettings.html#cfn-dynamodb-globaltable-capacityautoscalingsettings-targettrackingscalingpolicyconfiguration

builder

@Stability(Stable)
static CfnGlobalTablePropsMixin.CapacityAutoScalingSettingsProperty.Builder builder()

Returns:

a CfnGlobalTablePropsMixin.CapacityAutoScalingSettingsProperty.Builder of CfnGlobalTablePropsMixin.CapacityAutoScalingSettingsProperty