Class CfnScalingPolicyPropsMixin.TargetTrackingScalingPolicyConfigurationProperty

TargetTrackingScalingPolicyConfiguration is a property of the AWS::ApplicationAutoScaling::ScalingPolicy 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.

Inheritance

object

CfnScalingPolicyPropsMixin.TargetTrackingScalingPolicyConfigurationProperty

Implements

CfnScalingPolicyPropsMixin.ITargetTrackingScalingPolicyConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.ApplicationAutoScaling

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnScalingPolicyPropsMixin.TargetTrackingScalingPolicyConfigurationProperty : CfnScalingPolicyPropsMixin.ITargetTrackingScalingPolicyConfigurationProperty

Syntax (vb)

Public Class CfnScalingPolicyPropsMixin.TargetTrackingScalingPolicyConfigurationProperty Implements CfnScalingPolicyPropsMixin.ITargetTrackingScalingPolicyConfigurationProperty

Remarks

For more information, see Target tracking scaling policies in the Application Auto Scaling User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html

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.CfnPropertyMixins.AWS.ApplicationAutoScaling;

             var targetTrackingScalingPolicyConfigurationProperty = new TargetTrackingScalingPolicyConfigurationProperty {
                 CustomizedMetricSpecification = new CustomizedMetricSpecificationProperty {
                     Dimensions = new [] { new MetricDimensionProperty {
                         Name = "name",
                         Value = "value"
                     } },
                     MetricName = "metricName",
                     Metrics = new [] { new TargetTrackingMetricDataQueryProperty {
                         Expression = "expression",
                         Id = "id",
                         Label = "label",
                         MetricStat = new TargetTrackingMetricStatProperty {
                             Metric = new TargetTrackingMetricProperty {
                                 Dimensions = new [] { new TargetTrackingMetricDimensionProperty {
                                     Name = "name",
                                     Value = "value"
                                 } },
                                 MetricName = "metricName",
                                 Namespace = "namespace"
                             },
                             Stat = "stat",
                             Unit = "unit"
                         },
                         ReturnData = false
                     } },
                     Namespace = "namespace",
                     Statistic = "statistic",
                     Unit = "unit"
                 },
                 DisableScaleIn = false,
                 PredefinedMetricSpecification = new PredefinedMetricSpecificationProperty {
                     PredefinedMetricType = "predefinedMetricType",
                     ResourceLabel = "resourceLabel"
                 },
                 ScaleInCooldown = 123,
                 ScaleOutCooldown = 123,
                 TargetValue = 123
             };

Synopsis

Constructors

TargetTrackingScalingPolicyConfigurationProperty()

Properties

CustomizedMetricSpecification	A customized metric.
DisableScaleIn	Indicates whether scale in by the target tracking scaling policy is disabled.
PredefinedMetricSpecification	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, to wait for a previous scale-out activity to take effect.
TargetValue	The target value for the metric.

Constructors

TargetTrackingScalingPolicyConfigurationProperty()

public TargetTrackingScalingPolicyConfigurationProperty()

Remarks

For more information, see Target tracking scaling policies in the Application Auto Scaling User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html

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.CfnPropertyMixins.AWS.ApplicationAutoScaling;

             var targetTrackingScalingPolicyConfigurationProperty = new TargetTrackingScalingPolicyConfigurationProperty {
                 CustomizedMetricSpecification = new CustomizedMetricSpecificationProperty {
                     Dimensions = new [] { new MetricDimensionProperty {
                         Name = "name",
                         Value = "value"
                     } },
                     MetricName = "metricName",
                     Metrics = new [] { new TargetTrackingMetricDataQueryProperty {
                         Expression = "expression",
                         Id = "id",
                         Label = "label",
                         MetricStat = new TargetTrackingMetricStatProperty {
                             Metric = new TargetTrackingMetricProperty {
                                 Dimensions = new [] { new TargetTrackingMetricDimensionProperty {
                                     Name = "name",
                                     Value = "value"
                                 } },
                                 MetricName = "metricName",
                                 Namespace = "namespace"
                             },
                             Stat = "stat",
                             Unit = "unit"
                         },
                         ReturnData = false
                     } },
                     Namespace = "namespace",
                     Statistic = "statistic",
                     Unit = "unit"
                 },
                 DisableScaleIn = false,
                 PredefinedMetricSpecification = new PredefinedMetricSpecificationProperty {
                     PredefinedMetricType = "predefinedMetricType",
                     ResourceLabel = "resourceLabel"
                 },
                 ScaleInCooldown = 123,
                 ScaleOutCooldown = 123,
                 TargetValue = 123
             };

Properties

CustomizedMetricSpecification

A customized metric.

public object? CustomizedMetricSpecification { get; set; }

Property Value

object

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-customizedmetricspecification

Type union: either IResolvable or CfnScalingPolicyPropsMixin.ICustomizedMetricSpecificationProperty

DisableScaleIn

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

public object? DisableScaleIn { get; set; }

Property Value

object

Remarks

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 .

Type union: either bool or IResolvable

PredefinedMetricSpecification

A predefined metric.

public object? PredefinedMetricSpecification { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnScalingPolicyPropsMixin.IPredefinedMetricSpecificationProperty

ScaleInCooldown

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

public double? ScaleInCooldown { get; set; }

Property Value

double?

Remarks

For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide .

ScaleOutCooldown

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

public double? ScaleOutCooldown { get; set; }

Property Value

double?

Remarks

For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide .

TargetValue

The target value for the metric.

public double? TargetValue { get; set; }

Property Value

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. 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.

Implements

CfnScalingPolicyPropsMixin.ITargetTrackingScalingPolicyConfigurationProperty