Interface CfnServiceLevelObjective.IMetricDataQueryProperty

Use this structure to define a metric or metric math expression that you want to use as for a service level objective.

Namespace: Amazon.CDK.AWS.ApplicationSignals

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnServiceLevelObjective.IMetricDataQueryProperty

Syntax (vb)

Public Interface CfnServiceLevelObjective.IMetricDataQueryProperty

Remarks

Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData . The result of this expression used for the SLO.

For more information about metric math expressions, see Use metric math .

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-applicationsignals-servicelevelobjective-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.ApplicationSignals;

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

                 // the properties below are optional
                 AccountId = "accountId",
                 Expression = "expression",
                 MetricStat = new MetricStatProperty {
                     Metric = new MetricProperty {
                         Dimensions = new [] { new DimensionProperty {
                             Name = "name",
                             Value = "value"
                         } },
                         MetricName = "metricName",
                         Namespace = "namespace"
                     },
                     Period = 123,
                     Stat = "stat",

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

Synopsis

Properties

AccountId	The ID of the account where this metric is located.
Expression	This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this `MetricDataQueries` structure.
Id	A short name used to tie this object to the results in the response.
MetricStat	A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
ReturnData	Use this only if you are using a metric math expression for the SLO.

Properties

AccountId

The ID of the account where this metric is located.

string? AccountId { get; }

Property Value

string

Remarks

If you are performing this operation in a monitoring account, use this to specify which source account to retrieve this metric from.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricdataquery.html#cfn-applicationsignals-servicelevelobjective-metricdataquery-accountid

Expression

This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this MetricDataQueries structure.

string? Expression { get; }

Property Value

string

Remarks

A math expression can use the Id of the other metrics or queries to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .

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

Id

A short name used to tie this object to the results in the response.

string Id { get; }

Property Value

string

Remarks

This Id must be unique within a MetricDataQueries array. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the metric math expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

MetricStat

A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.

object? MetricStat { get; }

Property Value

object

Remarks

Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.

Type union: either IResolvable or CfnServiceLevelObjective.IMetricStatProperty

ReturnData

Use this only if you are using a metric math expression for the SLO.

object? ReturnData { get; }

Property Value

object

Remarks

Specify true for ReturnData for only the one expression result to use as the alarm. For all other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false .

Type union: either bool or IResolvable