software.amazon.awscdk.services.cloudwatch

Class Metric

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cloudwatch.Metric

All Implemented Interfaces:

IMetric, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/0.13.2 (build a2116e9)",
           date="2019-07-01T16:58:11.758Z")
 @Stability(value=Experimental)
public class Metric
extends software.amazon.jsii.JsiiObject
implements IMetric

A metric emitted by a service. The metric is a combination of a metric identifier (namespace, name and dimensions) and an aggregation function (statistic, period and unit). It also contains metadata which is used only in graphs, such as color and label. It makes sense to embed this in here, so that compound constructs can attach that metadata to metrics they expose. This class does not represent a resource, so hence is not a construct. Instead, Metric is an abstraction that makes it easy to specify metrics for use in both alarms and graphs. EXPERIMENTAL

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudwatch.IMetric

IMetric.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Metric(software.amazon.jsii.JsiiObject.InitializationMode mode)
	Metric(MetricProps props) EXPERIMENTAL

Method Summary

Modifier and Type	Method and Description
Alarm	createAlarm(software.amazon.awscdk.core.Construct scope, String id, CreateAlarmOptions props) Make a new Alarm for this metric.
String	getColor() EXPERIMENTAL
Map<String,Object>	getDimensions() EXPERIMENTAL
String	getLabel() EXPERIMENTAL
String	getMetricName() EXPERIMENTAL
String	getNamespace() EXPERIMENTAL
software.amazon.awscdk.core.Duration	getPeriod() EXPERIMENTAL
String	getStatistic() EXPERIMENTAL
Unit	getUnit() EXPERIMENTAL
static software.amazon.awscdk.services.iam.Grant	grantPutMetricData(software.amazon.awscdk.services.iam.IGrantable grantee) Grant permissions to the given identity to write metrics.
MetricAlarmConfig	toAlarmConfig() Turn this metric object into an alarm configuration.
MetricGraphConfig	toGraphConfig() Turn this metric object into a graph configuration.
String	toString() Returns a string representation of an object.
Metric	with(MetricOptions props) Return a copy of Metric with properties changed.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Metric

protected Metric(software.amazon.jsii.JsiiObject.InitializationMode mode)

Metric

@Stability(value=Experimental)
public Metric(MetricProps props)

EXPERIMENTAL

Method Detail

grantPutMetricData

@Stability(value=Experimental)
public static software.amazon.awscdk.services.iam.Grant grantPutMetricData(software.amazon.awscdk.services.iam.IGrantable grantee)

Grant permissions to the given identity to write metrics. EXPERIMENTAL

Parameters:

grantee - The IAM identity to give permissions to.

createAlarm

@Stability(value=Experimental)
public Alarm createAlarm(software.amazon.awscdk.core.Construct scope,
                                                        String id,
                                                        CreateAlarmOptions props)

Make a new Alarm for this metric. Combines both properties that may adjust the metric (aggregation) as well as alarm properties. EXPERIMENTAL

toAlarmConfig

@Stability(value=Experimental)
public MetricAlarmConfig toAlarmConfig()

Turn this metric object into an alarm configuration. EXPERIMENTAL

Specified by:

toAlarmConfig in interface IMetric

toGraphConfig

@Stability(value=Experimental)
public MetricGraphConfig toGraphConfig()

Turn this metric object into a graph configuration. EXPERIMENTAL

Specified by:

toGraphConfig in interface IMetric

toString

@Stability(value=Experimental)
public String toString()

Returns a string representation of an object. EXPERIMENTAL

Overrides:

toString in class Object

with

@Stability(value=Experimental)
public Metric with(MetricOptions props)

Return a copy of Metric with properties changed. All properties except namespace and metricName can be changed. EXPERIMENTAL

Parameters:

props - The set of properties to change.

getMetricName

@Stability(value=Experimental)
public String getMetricName()

EXPERIMENTAL

getNamespace

@Stability(value=Experimental)
public String getNamespace()

EXPERIMENTAL

getPeriod

@Stability(value=Experimental)
public software.amazon.awscdk.core.Duration getPeriod()

EXPERIMENTAL

getStatistic

@Stability(value=Experimental)
public String getStatistic()

EXPERIMENTAL

getColor

@Stability(value=Experimental)
 @Nullable
public String getColor()

EXPERIMENTAL

getDimensions

@Stability(value=Experimental)
 @Nullable
public Map<String,Object> getDimensions()

EXPERIMENTAL

getLabel

@Stability(value=Experimental)
 @Nullable
public String getLabel()

EXPERIMENTAL

getUnit

@Stability(value=Experimental)
 @Nullable
public Unit getUnit()

EXPERIMENTAL