Interface CfnScalingPolicy.IMetricDataQueryProperty

The metric data to return.

Namespace: Amazon.CDK.AWS.AutoScaling

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IMetricDataQueryProperty

Syntax (vb)

Public Interface IMetricDataQueryProperty

Remarks

Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.

MetricDataQuery is a property of the following property types:

Predictive scaling uses the time series data received from CloudWatch to understand how to schedule capacity based on your historical workload patterns.

You can call for a single metric or perform math expressions on multiple metrics. Any expressions used in a metric specification must eventually return a single time series.

For more information and examples, see Advanced predictive scaling policy configurations using custom metrics in the Amazon EC2 Auto Scaling User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricdataquery.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.AWS.AutoScaling;

var metricDataQueryProperty = new MetricDataQueryProperty {
    Id = "id",

    // the properties below are optional
    Expression = "expression",
    Label = "label",
    MetricStat = new MetricStatProperty {
        Metric = new MetricProperty {
            MetricName = "metricName",
            Namespace = "namespace",

            // the properties below are optional
            Dimensions = new [] { new MetricDimensionProperty {
                Name = "name",
                Value = "value"
            } }
        },
        Stat = "stat",

        // the properties below are optional
        Unit = "unit"
    },
    ReturnData = false
};

Synopsis

Properties

Expression	The math expression to perform on the returned data, if this object is performing a math expression.
Id	A short name that identifies the object's results in the response.
Label	A human-readable label for this metric or expression.
MetricStat	Information about the metric data to return.
ReturnData	Indicates whether to return the timestamps and raw data values of this metric.

Properties

Expression

The math expression to perform on the returned data, if this object is performing a math expression.

virtual string Expression { get; }

Property Value

System.String

Remarks

This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions.

Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat , but not both.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricdataquery.html#cfn-autoscaling-scalingpolicy-metricdataquery-expression

Id

A short name that identifies the object's results in the response.

string Id { get; }

Property Value

System.String

Remarks

This name must be unique among all MetricDataQuery objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricdataquery.html#cfn-autoscaling-scalingpolicy-metricdataquery-id

Label

A human-readable label for this metric or expression.

virtual string Label { get; }

Property Value

System.String

Remarks

This is especially useful if this is a math expression, so that you know what the value represents.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricdataquery.html#cfn-autoscaling-scalingpolicy-metricdataquery-label

MetricStat

Information about the metric data to return.

virtual object MetricStat { get; }

Property Value

System.Object

Remarks

Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat , but not both.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricdataquery.html#cfn-autoscaling-scalingpolicy-metricdataquery-metricstat

ReturnData

Indicates whether to return the timestamps and raw data values of this metric.

virtual object ReturnData { get; }

Property Value

System.Object

Remarks

If you use any math expressions, specify true for this value for only the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the metric specification.

If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData . This sets it to its default ( true ).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricdataquery.html#cfn-autoscaling-scalingpolicy-metricdataquery-returndata