Show / Hide Table of Contents

Class CfnScalingPolicyPropsMixin.PredictiveScalingMetricSpecificationProperty

This structure specifies the metrics and target utilization settings for a predictive scaling policy.

Inheritance
object
CfnScalingPolicyPropsMixin.PredictiveScalingMetricSpecificationProperty
Implements
CfnScalingPolicyPropsMixin.IPredictiveScalingMetricSpecificationProperty
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.PredictiveScalingMetricSpecificationProperty : CfnScalingPolicyPropsMixin.IPredictiveScalingMetricSpecificationProperty
Syntax (vb)
Public Class CfnScalingPolicyPropsMixin.PredictiveScalingMetricSpecificationProperty Implements CfnScalingPolicyPropsMixin.IPredictiveScalingMetricSpecificationProperty
Remarks

You must specify either a metric pair, or a load metric and a scaling metric individually. Specifying a metric pair instead of individual metrics provides a simpler way to configure metrics for a scaling policy. You choose the metric pair, and the policy automatically knows the correct sum and average statistics to use for the load metric and the scaling metric.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification.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 predictiveScalingMetricSpecificationProperty = new PredictiveScalingMetricSpecificationProperty {
                 CustomizedCapacityMetricSpecification = new PredictiveScalingCustomizedCapacityMetricProperty {
                     MetricDataQueries = new [] { new PredictiveScalingMetricDataQueryProperty {
                         Expression = "expression",
                         Id = "id",
                         Label = "label",
                         MetricStat = new PredictiveScalingMetricStatProperty {
                             Metric = new PredictiveScalingMetricProperty {
                                 Dimensions = new [] { new PredictiveScalingMetricDimensionProperty {
                                     Name = "name",
                                     Value = "value"
                                 } },
                                 MetricName = "metricName",
                                 Namespace = "namespace"
                             },
                             Stat = "stat",
                             Unit = "unit"
                         },
                         ReturnData = false
                     } }
                 },
                 CustomizedLoadMetricSpecification = new PredictiveScalingCustomizedLoadMetricProperty {
                     MetricDataQueries = new [] { new PredictiveScalingMetricDataQueryProperty {
                         Expression = "expression",
                         Id = "id",
                         Label = "label",
                         MetricStat = new PredictiveScalingMetricStatProperty {
                             Metric = new PredictiveScalingMetricProperty {
                                 Dimensions = new [] { new PredictiveScalingMetricDimensionProperty {
                                     Name = "name",
                                     Value = "value"
                                 } },
                                 MetricName = "metricName",
                                 Namespace = "namespace"
                             },
                             Stat = "stat",
                             Unit = "unit"
                         },
                         ReturnData = false
                     } }
                 },
                 CustomizedScalingMetricSpecification = new PredictiveScalingCustomizedScalingMetricProperty {
                     MetricDataQueries = new [] { new PredictiveScalingMetricDataQueryProperty {
                         Expression = "expression",
                         Id = "id",
                         Label = "label",
                         MetricStat = new PredictiveScalingMetricStatProperty {
                             Metric = new PredictiveScalingMetricProperty {
                                 Dimensions = new [] { new PredictiveScalingMetricDimensionProperty {
                                     Name = "name",
                                     Value = "value"
                                 } },
                                 MetricName = "metricName",
                                 Namespace = "namespace"
                             },
                             Stat = "stat",
                             Unit = "unit"
                         },
                         ReturnData = false
                     } }
                 },
                 PredefinedLoadMetricSpecification = new PredictiveScalingPredefinedLoadMetricProperty {
                     PredefinedMetricType = "predefinedMetricType",
                     ResourceLabel = "resourceLabel"
                 },
                 PredefinedMetricPairSpecification = new PredictiveScalingPredefinedMetricPairProperty {
                     PredefinedMetricType = "predefinedMetricType",
                     ResourceLabel = "resourceLabel"
                 },
                 PredefinedScalingMetricSpecification = new PredictiveScalingPredefinedScalingMetricProperty {
                     PredefinedMetricType = "predefinedMetricType",
                     ResourceLabel = "resourceLabel"
                 },
                 TargetValue = 123
             };

Synopsis

Constructors

PredictiveScalingMetricSpecificationProperty()

This structure specifies the metrics and target utilization settings for a predictive scaling policy.

Properties

CustomizedCapacityMetricSpecification

The customized capacity metric specification.

CustomizedLoadMetricSpecification

The customized load metric specification.

CustomizedScalingMetricSpecification

The customized scaling metric specification.

PredefinedLoadMetricSpecification

The predefined load metric specification.

PredefinedMetricPairSpecification

The predefined metric pair specification that determines the appropriate scaling metric and load metric to use.

PredefinedScalingMetricSpecification

The predefined scaling metric specification.

TargetValue

Specifies the target utilization.

Constructors

PredictiveScalingMetricSpecificationProperty()

This structure specifies the metrics and target utilization settings for a predictive scaling policy.

public PredictiveScalingMetricSpecificationProperty()
Remarks

You must specify either a metric pair, or a load metric and a scaling metric individually. Specifying a metric pair instead of individual metrics provides a simpler way to configure metrics for a scaling policy. You choose the metric pair, and the policy automatically knows the correct sum and average statistics to use for the load metric and the scaling metric.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predictivescalingmetricspecification.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 predictiveScalingMetricSpecificationProperty = new PredictiveScalingMetricSpecificationProperty {
                 CustomizedCapacityMetricSpecification = new PredictiveScalingCustomizedCapacityMetricProperty {
                     MetricDataQueries = new [] { new PredictiveScalingMetricDataQueryProperty {
                         Expression = "expression",
                         Id = "id",
                         Label = "label",
                         MetricStat = new PredictiveScalingMetricStatProperty {
                             Metric = new PredictiveScalingMetricProperty {
                                 Dimensions = new [] { new PredictiveScalingMetricDimensionProperty {
                                     Name = "name",
                                     Value = "value"
                                 } },
                                 MetricName = "metricName",
                                 Namespace = "namespace"
                             },
                             Stat = "stat",
                             Unit = "unit"
                         },
                         ReturnData = false
                     } }
                 },
                 CustomizedLoadMetricSpecification = new PredictiveScalingCustomizedLoadMetricProperty {
                     MetricDataQueries = new [] { new PredictiveScalingMetricDataQueryProperty {
                         Expression = "expression",
                         Id = "id",
                         Label = "label",
                         MetricStat = new PredictiveScalingMetricStatProperty {
                             Metric = new PredictiveScalingMetricProperty {
                                 Dimensions = new [] { new PredictiveScalingMetricDimensionProperty {
                                     Name = "name",
                                     Value = "value"
                                 } },
                                 MetricName = "metricName",
                                 Namespace = "namespace"
                             },
                             Stat = "stat",
                             Unit = "unit"
                         },
                         ReturnData = false
                     } }
                 },
                 CustomizedScalingMetricSpecification = new PredictiveScalingCustomizedScalingMetricProperty {
                     MetricDataQueries = new [] { new PredictiveScalingMetricDataQueryProperty {
                         Expression = "expression",
                         Id = "id",
                         Label = "label",
                         MetricStat = new PredictiveScalingMetricStatProperty {
                             Metric = new PredictiveScalingMetricProperty {
                                 Dimensions = new [] { new PredictiveScalingMetricDimensionProperty {
                                     Name = "name",
                                     Value = "value"
                                 } },
                                 MetricName = "metricName",
                                 Namespace = "namespace"
                             },
                             Stat = "stat",
                             Unit = "unit"
                         },
                         ReturnData = false
                     } }
                 },
                 PredefinedLoadMetricSpecification = new PredictiveScalingPredefinedLoadMetricProperty {
                     PredefinedMetricType = "predefinedMetricType",
                     ResourceLabel = "resourceLabel"
                 },
                 PredefinedMetricPairSpecification = new PredictiveScalingPredefinedMetricPairProperty {
                     PredefinedMetricType = "predefinedMetricType",
                     ResourceLabel = "resourceLabel"
                 },
                 PredefinedScalingMetricSpecification = new PredictiveScalingPredefinedScalingMetricProperty {
                     PredefinedMetricType = "predefinedMetricType",
                     ResourceLabel = "resourceLabel"
                 },
                 TargetValue = 123
             };

Properties

CustomizedCapacityMetricSpecification

The customized capacity metric specification.

public object? CustomizedCapacityMetricSpecification { get; set; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnScalingPolicyPropsMixin.IPredictiveScalingCustomizedCapacityMetricProperty

CustomizedLoadMetricSpecification

The customized load metric specification.

public object? CustomizedLoadMetricSpecification { get; set; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnScalingPolicyPropsMixin.IPredictiveScalingCustomizedLoadMetricProperty

CustomizedScalingMetricSpecification

The customized scaling metric specification.

public object? CustomizedScalingMetricSpecification { get; set; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnScalingPolicyPropsMixin.IPredictiveScalingCustomizedScalingMetricProperty

PredefinedLoadMetricSpecification

The predefined load metric specification.

public object? PredefinedLoadMetricSpecification { get; set; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnScalingPolicyPropsMixin.IPredictiveScalingPredefinedLoadMetricProperty

PredefinedMetricPairSpecification

The predefined metric pair specification that determines the appropriate scaling metric and load metric to use.

public object? PredefinedMetricPairSpecification { get; set; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnScalingPolicyPropsMixin.IPredictiveScalingPredefinedMetricPairProperty

PredefinedScalingMetricSpecification

The predefined scaling metric specification.

public object? PredefinedScalingMetricSpecification { get; set; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnScalingPolicyPropsMixin.IPredictiveScalingPredefinedScalingMetricProperty

TargetValue

Specifies the target utilization.

public double? TargetValue { get; set; }
Property Value

double?

Remarks

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

Implements

CfnScalingPolicyPropsMixin.IPredictiveScalingMetricSpecificationProperty
Back to top Generated by DocFX