Class CfnScalingPlan.TargetTrackingConfigurationProperty
TargetTrackingConfiguration
is a subproperty of ScalingInstruction that specifies a target tracking configuration for a scalable resource.
Inheritance
Namespace: Amazon.CDK.AWS.AutoScalingPlans
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class TargetTrackingConfigurationProperty : Object, CfnScalingPlan.ITargetTrackingConfigurationProperty
Syntax (vb)
Public Class TargetTrackingConfigurationProperty
Inherits Object
Implements CfnScalingPlan.ITargetTrackingConfigurationProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AutoScalingPlans;
var targetTrackingConfigurationProperty = new TargetTrackingConfigurationProperty {
TargetValue = 123,
// the properties below are optional
CustomizedScalingMetricSpecification = new CustomizedScalingMetricSpecificationProperty {
MetricName = "metricName",
Namespace = "namespace",
Statistic = "statistic",
// the properties below are optional
Dimensions = new [] { new MetricDimensionProperty {
Name = "name",
Value = "value"
} },
Unit = "unit"
},
DisableScaleIn = false,
EstimatedInstanceWarmup = 123,
PredefinedScalingMetricSpecification = new PredefinedScalingMetricSpecificationProperty {
PredefinedScalingMetricType = "predefinedScalingMetricType",
// the properties below are optional
ResourceLabel = "resourceLabel"
},
ScaleInCooldown = 123,
ScaleOutCooldown = 123
};
Synopsis
Constructors
TargetTrackingConfigurationProperty() |
Properties
CustomizedScalingMetricSpecification | A customized metric. |
DisableScaleIn | Indicates whether scale in by the target tracking scaling policy is disabled. |
EstimatedInstanceWarmup | The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. |
PredefinedScalingMetricSpecification | A predefined metric. |
ScaleInCooldown | The amount of time, in seconds, after a scale-in activity completes before another scale in activity can start. |
ScaleOutCooldown | The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. |
TargetValue | The target value for the metric. |
Constructors
TargetTrackingConfigurationProperty()
public TargetTrackingConfigurationProperty()
Properties
CustomizedScalingMetricSpecification
A customized metric.
public object CustomizedScalingMetricSpecification { get; set; }
Property Value
System.Object
Remarks
You can specify either a predefined metric or a customized metric.
DisableScaleIn
Indicates whether scale in by the target tracking scaling policy is disabled.
public object DisableScaleIn { get; set; }
Property Value
System.Object
Remarks
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
.
EstimatedInstanceWarmup
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
public Nullable<double> EstimatedInstanceWarmup { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
This value is used only if the resource is an Auto Scaling group.
PredefinedScalingMetricSpecification
A predefined metric.
public object PredefinedScalingMetricSpecification { get; set; }
Property Value
System.Object
Remarks
You can specify either a predefined metric or a customized metric.
ScaleInCooldown
The amount of time, in seconds, after a scale-in activity completes before another scale in activity can start.
public Nullable<double> ScaleInCooldown { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
This value is not used if the scalable resource is an Auto Scaling group.
ScaleOutCooldown
The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.
public Nullable<double> ScaleOutCooldown { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
This value is not used if the scalable resource is an Auto Scaling group.
TargetValue
The target value for the metric.
public double TargetValue { get; set; }
Property Value
System.Double
Remarks
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.