Optional
colorOptional
dimensionsThe dimensions for this metric. For the list of available dimensions see the AWS documentation here.
Optional
extendedThe percentile statistic for the metric associated with the alarm. Specify a value between [0.0] and [100].
Optional
labelThe label to display for this metric in the graph legend. If this is not specified, the metric is given an autogenerated label that distinguishes it from the other metrics in the widget.
Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].
The name for this metric. See docs for supported metrics.
The namespace for this metric. See docs for the list of namespaces. See docs for supported metrics.
Optional
periodThe period in seconds over which the specified stat
is applied. Must be in multiples of 60.
Default to [300] if unspecified.
Optional
statisticThe statistic to apply to the alarm's associated metric. Either of the following is
supported: SampleCount
, Average
, Sum
, Minimum
, Maximum
Optional
unitThe unit for this metric.
See https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html
Optional
visibleSet this to true to have the metric appear in the graph, or false to have it be hidden. The default is true.
Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].
Optional
yWhere on the graph to display the y-axis for this metric. The default is left.
Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].
Generated using TypeDoc
The six-digit HTML hex color code to be used for this metric.
Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].