MetricProps
- class aws_cdk.aws_cloudwatch.MetricProps(*, account=None, color=None, dimensions_map=None, label=None, period=None, region=None, statistic=None, unit=None, metric_name, namespace)
Bases:
CommonMetricOptions
Properties for a metric.
- Parameters:
account (
Optional
[str
]) – Account which this metric comes from. Default: - Deployment account.color (
Optional
[str
]) – The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. TheColor
class has a set of standard colors that can be used here. Default: - Automatic colordimensions_map (
Optional
[Mapping
[str
,str
]]) – Dimensions of the metric. Default: - No dimensions.label (
Optional
[str
]) – Label for this metric when added to a Graph in a Dashboard. You can use dynamic labels to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph’s legend. Default: - No labelperiod (
Optional
[Duration
]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)region (
Optional
[str
]) – Region which this metric comes from. Default: - Deployment region.statistic (
Optional
[str
]) – What function to use for aggregating. Use theaws_cloudwatch.Stats
helper class to construct valid input strings. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” - “tmNN.NN” | “tm(NN.NN%:NN.NN%)” - “iqm” - “wmNN.NN” | “wm(NN.NN%:NN.NN%)” - “tcNN.NN” | “tc(NN.NN%:NN.NN%)” - “tsNN.NN” | “ts(NN.NN%:NN.NN%)” Default: Averageunit (
Optional
[Unit
]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric streammetric_name (
str
) – Name of the metric.namespace (
str
) – Namespace of the metric.
- ExampleMetadata:
infused
Example:
import aws_cdk.aws_cloudwatch as cloudwatch metric = cloudwatch.Metric( namespace="MyNamespace", metric_name="MyMetric", dimensions_map={"MyDimension": "MyDimensionValue"} ) alarm = cloudwatch.Alarm(self, "MyAlarm", metric=metric, threshold=100, evaluation_periods=3, datapoints_to_alarm=2 ) topic_rule = iot.TopicRule(self, "TopicRule", sql=iot.IotSql.from_string_as_ver20160323("SELECT topic(2) as device_id FROM 'device/+/data'"), actions=[ actions.CloudWatchSetAlarmStateAction(alarm, reason="AWS Iot Rule action is triggered", alarm_state_to_set=cloudwatch.AlarmState.ALARM ) ] )
Attributes
- account
Account which this metric comes from.
- Default:
Deployment account.
- color
The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The
Color
class has a set of standard colors that can be used here.- Default:
Automatic color
- dimensions_map
Dimensions of the metric.
- Default:
No dimensions.
- label
Label for this metric when added to a Graph in a Dashboard.
You can use dynamic labels to show summary information about the entire displayed time series in the legend. For example, if you use:
[max: ${MAX}] MyMetric
As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph’s legend.
- Default:
No label
- metric_name
Name of the metric.
- namespace
Namespace of the metric.
- period
The period over which the specified statistic is applied.
- Default:
Duration.minutes(5)
- region
Region which this metric comes from.
- Default:
Deployment region.
- statistic
What function to use for aggregating.
Use the
aws_cloudwatch.Stats
helper class to construct valid input strings.Can be one of the following:
“Minimum” | “min”
“Maximum” | “max”
“Average” | “avg”
“Sum” | “sum”
“SampleCount | “n”
“pNN.NN”
“tmNN.NN” | “tm(NN.NN%:NN.NN%)”
“iqm”
“wmNN.NN” | “wm(NN.NN%:NN.NN%)”
“tcNN.NN” | “tc(NN.NN%:NN.NN%)”
“tsNN.NN” | “ts(NN.NN%:NN.NN%)”
- Default:
Average
- unit
Unit used to filter the metric stream.
Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units.
The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases.
CloudWatch does not honor this property for graphs.
- Default:
All metric datums in the given metric stream