CommonMetricOptions

class aws_cdk.aws_cloudwatch.CommonMetricOptions(*, account=None, color=None, dimensions=None, dimensions_map=None, label=None, period=None, region=None, statistic=None, unit=None)

Bases: object

Options shared by most methods accepting metric options.

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. The Color class has a set of standard colors that can be used here. Default: - Automatic color

  • dimensions (Optional[Mapping[str, Any]]) – (deprecated) Dimensions of the metric. Default: - No dimensions.

  • dimensions_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 label

  • period (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. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average

  • unit (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 stream

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_cloudwatch as cloudwatch
import aws_cdk.core as cdk

# dimensions: Any

common_metric_options = cloudwatch.CommonMetricOptions(
    account="account",
    color="color",
    dimensions={
        "dimensions_key": dimensions
    },
    dimensions_map={
        "dimensions_map_key": "dimensionsMap"
    },
    label="label",
    period=cdk.Duration.minutes(30),
    region="region",
    statistic="statistic",
    unit=cloudwatch.Unit.SECONDS
)

Attributes

account

Account which this metric comes from.

Default

  • Deployment account.

Return type

Optional[str]

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

Return type

Optional[str]

dimensions

(deprecated) Dimensions of the metric.

Default

  • No dimensions.

Deprecated

Use ‘dimensionsMap’ instead.

Stability

deprecated

Return type

Optional[Mapping[str, Any]]

dimensions_map

Dimensions of the metric.

Default

  • No dimensions.

Return type

Optional[Mapping[str, str]]

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

Return type

Optional[str]

period

The period over which the specified statistic is applied.

Default

Duration.minutes(5)

Return type

Optional[Duration]

region

Region which this metric comes from.

Default

  • Deployment region.

Return type

Optional[str]

statistic

What function to use for aggregating.

Can be one of the following:

  • “Minimum” | “min”

  • “Maximum” | “max”

  • “Average” | “avg”

  • “Sum” | “sum”

  • “SampleCount | “n”

  • “pNN.NN”

Default

Average

Return type

Optional[str]

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

Return type

Optional[Unit]