Package software.amazon.awscdk.services.cloudwatch

Interface CfnAlarm.MetricProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAlarm.MetricProperty.Jsii$Proxy

Enclosing class:

CfnAlarm

@Stability(Stable)
public static interface CfnAlarm.MetricProperty
extends software.amazon.jsii.JsiiSerializable

The Metric property type represents a specific metric.

Metric is a property of the MetricStat property type.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudwatch.*;
 MetricProperty metricProperty = MetricProperty.builder()
         .dimensions(List.of(DimensionProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .metricName("metricName")
         .namespace("namespace")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAlarm.MetricProperty.Builder	A builder for CfnAlarm.MetricProperty
static final class	CfnAlarm.MetricProperty.Jsii$Proxy	An implementation for CfnAlarm.MetricProperty

Method Summary

Modifier and Type	Method	Description
static CfnAlarm.MetricProperty.Builder	builder()
default Object	getDimensions()	The metric dimensions that you want to be used for the metric that the alarm will watch.
default String	getMetricName()	The name of the metric that you want the alarm to watch.
default String	getNamespace()	The namespace of the metric that the alarm will watch.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDimensions

@Stability(Stable)
@Nullable
default Object getDimensions()

The metric dimensions that you want to be used for the metric that the alarm will watch.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAlarm.DimensionProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html#cfn-cloudwatch-alarm-metric-dimensions

getMetricName

@Stability(Stable)
@Nullable
default String getMetricName()

The name of the metric that you want the alarm to watch.

This is a required field.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html#cfn-cloudwatch-alarm-metric-metricname

getNamespace

@Stability(Stable)
@Nullable
default String getNamespace()

The namespace of the metric that the alarm will watch.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html#cfn-cloudwatch-alarm-metric-namespace

builder

@Stability(Stable)
static CfnAlarm.MetricProperty.Builder builder()

Returns:

a CfnAlarm.MetricProperty.Builder of CfnAlarm.MetricProperty