software.amazon.awscdk.services.applicationautoscaling

Interface CfnScalingPolicy.TargetTrackingScalingPolicyConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScalingPolicy.TargetTrackingScalingPolicyConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnScalingPolicy

@Stability(value=Stable)
public static interface CfnScalingPolicy.TargetTrackingScalingPolicyConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

`TargetTrackingScalingPolicyConfiguration` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html) resource that specifies a target tracking scaling policy configuration for Application Auto Scaling. Use a target tracking scaling policy to adjust the capacity of the specified scalable target in response to actual workloads, so that resource utilization remains at or near the target utilization value.

For more information, see PutScalingPolicy in the Application Auto Scaling API Reference . For more information about target tracking scaling policies, see Target tracking scaling policies in the Application Auto Scaling User 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.applicationautoscaling.*;
 TargetTrackingScalingPolicyConfigurationProperty targetTrackingScalingPolicyConfigurationProperty = TargetTrackingScalingPolicyConfigurationProperty.builder()
         .targetValue(123)
         // the properties below are optional
         .customizedMetricSpecification(CustomizedMetricSpecificationProperty.builder()
                 .metricName("metricName")
                 .namespace("namespace")
                 .statistic("statistic")
                 // the properties below are optional
                 .dimensions(List.of(MetricDimensionProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .unit("unit")
                 .build())
         .disableScaleIn(false)
         .predefinedMetricSpecification(PredefinedMetricSpecificationProperty.builder()
                 .predefinedMetricType("predefinedMetricType")
                 // the properties below are optional
                 .resourceLabel("resourceLabel")
                 .build())
         .scaleInCooldown(123)
         .scaleOutCooldown(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnScalingPolicy.TargetTrackingScalingPolicyConfigurationProperty.Builder	builder()
default Object	getCustomizedMetricSpecification() A customized metric.
default Object	getDisableScaleIn() Indicates whether scale in by the target tracking scaling policy is disabled.
default Object	getPredefinedMetricSpecification() A predefined metric.
default Number	getScaleInCooldown() The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
default Number	getScaleOutCooldown() The amount of time, in seconds, to wait for a previous scale-out activity to take effect.
Number	getTargetValue() The target value for the metric.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getTargetValue

@Stability(value=Stable)
 @NotNull
Number getTargetValue()

The target value for the metric.

Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.

getCustomizedMetricSpecification

@Stability(value=Stable)
 @Nullable
default Object getCustomizedMetricSpecification()

A customized metric.

You can specify either a predefined metric or a customized metric.

getDisableScaleIn

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

Indicates whether scale in by the target tracking scaling policy is disabled.

If the value is true , scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false .

getPredefinedMetricSpecification

@Stability(value=Stable)
 @Nullable
default Object getPredefinedMetricSpecification()

A predefined metric.

You can specify either a predefined metric or a customized metric.

getScaleInCooldown

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

The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.

With the scale-in cooldown period , the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Application Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.

Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:

• AppStream 2.0 fleets
• Aurora DB clusters
• ECS services
• EMR clusters
• Neptune clusters
• SageMaker endpoint variants
• Spot Fleets
• Custom resources

For all other scalable targets, the default value is 0:

• Amazon Comprehend document classification and entity recognizer endpoints
• DynamoDB tables and global secondary indexes
• Amazon Keyspaces tables
• Lambda provisioned concurrency
• Amazon MSK broker storage

getScaleOutCooldown

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

The amount of time, in seconds, to wait for a previous scale-out activity to take effect.

With the scale-out cooldown period , the intention is to continuously (but not excessively) scale out. After Application Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends. While the cooldown period is in effect, the capacity added by the initiating scale-out activity is calculated as part of the desired capacity for the next scale-out activity.

Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:

• AppStream 2.0 fleets
• Aurora DB clusters
• ECS services
• EMR clusters
• Neptune clusters
• SageMaker endpoint variants
• Spot Fleets
• Custom resources

For all other scalable targets, the default value is 0:

• Amazon Comprehend document classification and entity recognizer endpoints
• DynamoDB tables and global secondary indexes
• Amazon Keyspaces tables
• Lambda provisioned concurrency
• Amazon MSK broker storage

builder

@Stability(value=Stable)
static CfnScalingPolicy.TargetTrackingScalingPolicyConfigurationProperty.Builder builder()

Returns:

a CfnScalingPolicy.TargetTrackingScalingPolicyConfigurationProperty.Builder of CfnScalingPolicy.TargetTrackingScalingPolicyConfigurationProperty