Package software.amazon.awscdk.services.cloudwatch

Interface MetricProps

All Superinterfaces:

CommonMetricOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

MetricProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:36.881Z")
@Stability(Stable)
public interface MetricProps
extends software.amazon.jsii.JsiiSerializable, CommonMetricOptions

Properties for a metric.

Example:

 HostedZone hostedZone = HostedZone.Builder.create(this, "MyHostedZone").zoneName("example.org").build();
 Metric metric = Metric.Builder.create()
         .namespace("AWS/Route53")
         .metricName("DNSQueries")
         .dimensionsMap(Map.of(
                 "HostedZoneId", hostedZone.getHostedZoneId()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MetricProps.Builder	builder()
String	getMetricName()	Name of the metric.
String	getNamespace()	Namespace of the metric.

Methods inherited from interface software.amazon.awscdk.services.cloudwatch.CommonMetricOptions

getAccount, getColor, getDimensions, getDimensionsMap, getLabel, getPeriod, getRegion, getStatistic, getUnit

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMetricName

@Stability(Stable)
@NotNull
String getMetricName()

Name of the metric.

getNamespace

@Stability(Stable)
@NotNull
String getNamespace()

Namespace of the metric.

builder

@Stability(Stable)
static MetricProps.Builder builder()

Returns:

a MetricProps.Builder of MetricProps