Interface CfnServiceLevelObjective.IMetricStatProperty

This structure defines the metric to be used as the service level indicator, along with the statistics, period, and unit.

Namespace: Amazon.CDK.AWS.ApplicationSignals

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnServiceLevelObjective.IMetricStatProperty

Syntax (vb)

Public Interface CfnServiceLevelObjective.IMetricStatProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metricstat.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 metricStatProperty = 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"
             };

Synopsis

Properties

Metric	The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
Period	The granularity, in seconds, to be used for the metric.
Stat	The statistic to use for comparison to the threshold.
Unit	If you omit `Unit` then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch.

Properties

Metric

The metric to use as the service level indicator, including the metric name, namespace, and dimensions.

object Metric { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnServiceLevelObjective.IMetricProperty

Period

The granularity, in seconds, to be used for the metric.

double Period { get; }

Property Value

double

Remarks

For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

Stat

The statistic to use for comparison to the threshold.

string Stat { get; }

Property Value

string

Remarks

It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions .

Unit

If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch.

string? Unit { get; }

Property Value

string

Remarks

If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.