aws-cdk-lib.aws_autoscalingplans.CfnScalingPlan.TargetTrackingConfigurationProperty

TargetTrackingConfigurationProperty Struct

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

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_autoscalingplans as autoscalingplans } from 'aws-cdk-lib';
const targetTrackingConfigurationProperty: autoscalingplans.CfnScalingPlan.TargetTrackingConfigurationProperty = {
  targetValue: 123,

  // the properties below are optional
  customizedScalingMetricSpecification: {
    metricName: 'metricName',
    namespace: 'namespace',
    statistic: 'statistic',

    // the properties below are optional
    dimensions: [{
      name: 'name',
      value: 'value',
    }],
    unit: 'unit',
  },
  disableScaleIn: false,
  estimatedInstanceWarmup: 123,
  predefinedScalingMetricSpecification: {
    predefinedScalingMetricType: 'predefinedScalingMetricType',

    // the properties below are optional
    resourceLabel: 'resourceLabel',
  },
  scaleInCooldown: 123,
  scaleOutCooldown: 123,
};

Properties

customizedScalingMetricSpecificationIResolvable | CfnScalingPlan.CustomizedScalingMetricSpecificationPropertycustomized_scaling_metric_specificationtyping.Union[IResolvable, CustomizedScalingMetricSpecificationProperty]customizedScalingMetricSpecificationIResolvableCustomizedScalingMetricSpecificationIResolvableCustomizedScalingMetricSpecificationinterface{}#

A customized metric.

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

disableScaleInboolean | IResolvabledisable_scale_intyping.Union[bool, IResolvable]disableScaleInBooleanDisableScaleInboolDisableScaleIninterface{}#

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

notes

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 .

estimatedInstanceWarmupnumberestimated_instance_warmupint | floatestimatedInstanceWarmupNumberEstimatedInstanceWarmupdoubleEstimatedInstanceWarmup*float64#

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.

predefinedScalingMetricSpecificationIResolvable | CfnScalingPlan.PredefinedScalingMetricSpecificationPropertypredefined_scaling_metric_specificationtyping.Union[IResolvable, PredefinedScalingMetricSpecificationProperty]predefinedScalingMetricSpecificationIResolvablePredefinedScalingMetricSpecificationIResolvablePredefinedScalingMetricSpecificationinterface{}#

A predefined metric.

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

scaleInCooldownnumberscale_in_cooldownint | floatscaleInCooldownNumberScaleInCooldowndoubleScaleInCooldown*float64#

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.

scaleOutCooldownnumberscale_out_cooldownint | floatscaleOutCooldownNumberScaleOutCooldowndoubleScaleOutCooldown*float64#

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.

targetValuenumbertarget_valueint | floattargetValueNumberTargetValuedoubleTargetValue*float64required#

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.