Package software.amazon.awscdk.services.autoscalingplans

Interface CfnScalingPlan.TargetTrackingConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScalingPlan.TargetTrackingConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnScalingPlan

@Stability(Stable)
public static interface CfnScalingPlan.TargetTrackingConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

TargetTrackingConfiguration is a subproperty of ScalingInstruction that specifies a target tracking configuration for a scalable resource.

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.autoscalingplans.*;
 TargetTrackingConfigurationProperty targetTrackingConfigurationProperty = TargetTrackingConfigurationProperty.builder()
         .targetValue(123)
         // the properties below are optional
         .customizedScalingMetricSpecification(CustomizedScalingMetricSpecificationProperty.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)
         .estimatedInstanceWarmup(123)
         .predefinedScalingMetricSpecification(PredefinedScalingMetricSpecificationProperty.builder()
                 .predefinedScalingMetricType("predefinedScalingMetricType")
                 // the properties below are optional
                 .resourceLabel("resourceLabel")
                 .build())
         .scaleInCooldown(123)
         .scaleOutCooldown(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnScalingPlan.TargetTrackingConfigurationProperty.Builder	builder()
default Object	getCustomizedScalingMetricSpecification()	A customized metric.
default Object	getDisableScaleIn()	Indicates whether scale in by the target tracking scaling policy is disabled.
default Number	getEstimatedInstanceWarmup()	The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
default Object	getPredefinedScalingMetricSpecification()	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, after a scale-out activity completes before another scale-out activity can start.
Number	getTargetValue()	The target value for the metric.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTargetValue

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-targetvalue

getCustomizedScalingMetricSpecification

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

A customized metric.

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

Returns union: either IResolvable or CfnScalingPlan.CustomizedScalingMetricSpecificationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-customizedscalingmetricspecification

getDisableScaleIn

@Stability(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 doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource.

The default value is false .

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-disablescalein

getEstimatedInstanceWarmup

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

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

This value is used only if the resource is an Auto Scaling group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-estimatedinstancewarmup

getPredefinedScalingMetricSpecification

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

A predefined metric.

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

Returns union: either IResolvable or CfnScalingPlan.PredefinedScalingMetricSpecificationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-predefinedscalingmetricspecification

getScaleInCooldown

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

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

This value is not used if the scalable resource is an Auto Scaling group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-scaleincooldown

getScaleOutCooldown

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

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

This value is not used if the scalable resource is an Auto Scaling group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-scaleoutcooldown

builder

@Stability(Stable)
static CfnScalingPlan.TargetTrackingConfigurationProperty.Builder builder()

Returns:

a CfnScalingPlan.TargetTrackingConfigurationProperty.Builder of CfnScalingPlan.TargetTrackingConfigurationProperty