Class BasicTargetTrackingScalingPolicyProps
Properties for a Target Tracking policy that include the metric but exclude the target.
Inheritance
Namespace: Amazon.CDK.AWS.AutoScaling
Assembly: Amazon.CDK.AWS.AutoScaling.dll
Syntax (csharp)
public class BasicTargetTrackingScalingPolicyProps : Object, IBasicTargetTrackingScalingPolicyProps, IBaseTargetTrackingPropsSyntax (vb)
Public Class BasicTargetTrackingScalingPolicyProps
Inherits Object
Implements IBasicTargetTrackingScalingPolicyProps, IBaseTargetTrackingPropsRemarks
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.AutoScaling;
using Amazon.CDK.AWS.CloudWatch;
using Amazon.CDK;
Metric metric;
var basicTargetTrackingScalingPolicyProps = new BasicTargetTrackingScalingPolicyProps {
TargetValue = 123,
// the properties below are optional
Cooldown = Duration.Minutes(30),
CustomMetric = metric,
DisableScaleIn = false,
EstimatedInstanceWarmup = Duration.Minutes(30),
PredefinedMetric = PredefinedMetric.ASG_AVERAGE_CPU_UTILIZATION,
ResourceLabel = "resourceLabel"
};Synopsis
Constructors
| BasicTargetTrackingScalingPolicyProps() |
Properties
| Cooldown | Period after a scaling completes before another scaling activity can start. |
| CustomMetric | A custom metric for application autoscaling. |
| DisableScaleIn | Indicates whether scale in by the target tracking policy is disabled. |
| EstimatedInstanceWarmup | Estimated time until a newly launched instance can send metrics to CloudWatch. |
| PredefinedMetric | A predefined metric for application autoscaling. |
| ResourceLabel | The resource label associated with the predefined metric. |
| TargetValue | The target value for the metric. |
Constructors
BasicTargetTrackingScalingPolicyProps()
public BasicTargetTrackingScalingPolicyProps()Properties
Cooldown
Period after a scaling completes before another scaling activity can start.
public Duration Cooldown { get; set; }Property Value
Remarks
Default: - The default cooldown configured on the AutoScalingGroup.
CustomMetric
A custom metric for application autoscaling.
public IMetric CustomMetric { get; set; }Property Value
Remarks
The metric must track utilization. Scaling out will happen if the metric is higher than the target value, scaling in will happen in the metric is lower than the target value.
Exactly one of customMetric or predefinedMetric must be specified.
Default: - No custom metric.
DisableScaleIn
Indicates whether scale in by the target tracking policy is disabled.
public Nullable<bool> DisableScaleIn { get; set; }Property Value
System.Nullable<System.Boolean>
Remarks
If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the autoscaling group. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the group.
Default: false
EstimatedInstanceWarmup
Estimated time until a newly launched instance can send metrics to CloudWatch.
public Duration EstimatedInstanceWarmup { get; set; }Property Value
Remarks
Default: - Same as the cooldown.
PredefinedMetric
A predefined metric for application autoscaling.
public Nullable<PredefinedMetric> PredefinedMetric { get; set; }Property Value
System.Nullable<PredefinedMetric>
Remarks
The metric must track utilization. Scaling out will happen if the metric is higher than the target value, scaling in will happen in the metric is lower than the target value.
Exactly one of customMetric or predefinedMetric must be specified.
Default: - No predefined metric.
ResourceLabel
The resource label associated with the predefined metric.
public string ResourceLabel { get; set; }Property Value
System.String
Remarks
Should be supplied if the predefined metric is ALBRequestCountPerTarget, and the format should be:
app/
Default: - No resource label.
TargetValue
The target value for the metric.
public double TargetValue { get; set; }Property Value
System.Double