Package software.amazon.awscdk.services.cassandra

Interface CfnTable.AutoScalingSettingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTable.AutoScalingSettingProperty.Jsii$Proxy

Enclosing class:

CfnTable

@Stability(Stable)
public static interface CfnTable.AutoScalingSettingProperty
extends software.amazon.jsii.JsiiSerializable

The optional auto scaling settings for a table with provisioned throughput capacity.

To turn on auto scaling for a table in throughputMode:PROVISIONED , you must specify the following parameters.

Configure the minimum and maximum capacity units. The auto scaling policy ensures that capacity never goes below the minimum or above the maximum range.

• minimumUnits : The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).
• maximumUnits : The maximum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).
• scalingPolicy : Amazon Keyspaces supports the target tracking scaling policy. The auto scaling target is a percentage of the provisioned capacity of the table.

For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cassandra.*;
 AutoScalingSettingProperty autoScalingSettingProperty = AutoScalingSettingProperty.builder()
         .autoScalingDisabled(false)
         .maximumUnits(123)
         .minimumUnits(123)
         .scalingPolicy(ScalingPolicyProperty.builder()
                 .targetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfigurationProperty.builder()
                         .targetValue(123)
                         // the properties below are optional
                         .disableScaleIn(false)
                         .scaleInCooldown(123)
                         .scaleOutCooldown(123)
                         .build())
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-autoscalingsetting.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTable.AutoScalingSettingProperty.Builder	builder()
default Object	getAutoScalingDisabled()	This optional parameter enables auto scaling for the table if set to false .
default Number	getMaximumUnits()	Manage costs by specifying the maximum amount of throughput to provision.
default Number	getMinimumUnits()	The minimum level of throughput the table should always be ready to support.
default Object	getScalingPolicy()	Amazon Keyspaces supports the target tracking auto scaling policy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAutoScalingDisabled

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

This optional parameter enables auto scaling for the table if set to false .

Returns union: either Boolean or IResolvable

Default: - false

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-autoscalingsetting.html#cfn-cassandra-table-autoscalingsetting-autoscalingdisabled

getMaximumUnits

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

Manage costs by specifying the maximum amount of throughput to provision.

The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-autoscalingsetting.html#cfn-cassandra-table-autoscalingsetting-maximumunits

getMinimumUnits

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

The minimum level of throughput the table should always be ready to support.

The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-autoscalingsetting.html#cfn-cassandra-table-autoscalingsetting-minimumunits

getScalingPolicy

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

Amazon Keyspaces supports the target tracking auto scaling policy.

With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90.

Returns union: either IResolvable or CfnTable.ScalingPolicyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cassandra-table-autoscalingsetting.html#cfn-cassandra-table-autoscalingsetting-scalingpolicy

builder

@Stability(Stable)
static CfnTable.AutoScalingSettingProperty.Builder builder()

Returns:

a CfnTable.AutoScalingSettingProperty.Builder of CfnTable.AutoScalingSettingProperty