Package software.amazon.awscdk.services.cassandra

Interface CfnTable.TargetTrackingScalingPolicyConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTable.TargetTrackingScalingPolicyConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnTable

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

Amazon Keyspaces supports the target tracking auto scaling policy for a provisioned table.

This policy scales a table based on the ratio of consumed to provisioned capacity. The auto scaling target is a percentage of the provisioned capacity of the table.

• targetTrackingScalingPolicyConfiguration : To define the target tracking policy, you must define the target value.
• targetValue : The target utilization rate of the table. Amazon Keyspaces auto scaling ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define targetValue as a percentage. A double between 20 and 90. (Required)
• disableScaleIn : A boolean that specifies if scale-in is disabled or enabled for the table. This parameter is disabled by default. To turn on scale-in , set the boolean value to FALSE . This means that capacity for a table can be automatically scaled down on your behalf. (Optional)
• scaleInCooldown : A cooldown period in seconds between scaling activities that lets the table stabilize before another scale in activity starts. If no value is provided, the default is 0. (Optional)
• scaleOutCooldown : A cooldown period in seconds between scaling activities that lets the table stabilize before another scale out activity starts. If no value is provided, the default is 0. (Optional)

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.*;
 TargetTrackingScalingPolicyConfigurationProperty targetTrackingScalingPolicyConfigurationProperty = TargetTrackingScalingPolicyConfigurationProperty.builder()
         .targetValue(123)
         // the properties below are optional
         .disableScaleIn(false)
         .scaleInCooldown(123)
         .scaleOutCooldown(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTable.TargetTrackingScalingPolicyConfigurationProperty.Builder	builder()
default Object	getDisableScaleIn()	Specifies if scale-in is enabled.
default Number	getScaleInCooldown()	Specifies a scale-in cool down period.
default Number	getScaleOutCooldown()	Specifies a scale out cool down period.
Number	getTargetValue()	Specifies the target value for the target tracking auto scaling policy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTargetValue

@Stability(Stable)
@NotNull
Number getTargetValue()

Specifies the target value for the target tracking auto scaling policy.

Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define targetValue as a percentage. An integer between 20 and 90.

See Also:

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

getDisableScaleIn

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

Specifies if scale-in is enabled.

When auto scaling automatically decreases capacity for a table, the table scales in . When scaling policies are set, they can't scale in the table lower than its minimum capacity.

See Also:

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

getScaleInCooldown

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

Specifies a scale-in cool down period.

A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.

Default: - 0

See Also:

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

getScaleOutCooldown

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

Specifies a scale out cool down period.

A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.

Default: - 0

See Also:

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

builder

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

Returns:

a CfnTable.TargetTrackingScalingPolicyConfigurationProperty.Builder of CfnTable.TargetTrackingScalingPolicyConfigurationProperty