Metric

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.cloudwatch.Metric

All Implemented Interfaces:

IMetric
```
@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:20.181Z")
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.
Example:
```
 Function fn;
 Metric minuteErrorRate = fn.metricErrors(MetricOptions.builder()
         .statistic("avg")
         .period(Duration.minutes(1))
         .label("Lambda failure rate")
         .build());
 
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Metric.Builder
A fluent builder for Metric.
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudwatch.IMetric
  IMetric.Jsii$Default, IMetric.Jsii$Proxy

Nested Classes
Modifier and Type	Class and Description
`static class`	`Metric.Builder` A fluent builder for `Metric`.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Metric(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`Metric(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Metric`	`attachTo(software.constructs.IConstruct scope)` Attach the metric object to the given construct scope.
`Alarm`	`createAlarm(Construct scope, java.lang.String id, CreateAlarmOptions props)` Make a new Alarm for this metric.
`java.lang.String`	`getAccount()` Account which this metric comes from.
`java.lang.String`	`getColor()` The hex color code used when this metric is rendered on a graph.
`java.util.Map<java.lang.String,java.lang.Object>`	`getDimensions()` Dimensions of this metric.
`java.lang.String`	`getLabel()` Label for this metric when added to a Graph in a Dashboard.
`java.lang.String`	`getMetricName()` Name of this metric.
`java.lang.String`	`getNamespace()` Namespace of this metric.
`Duration`	`getPeriod()` Period of this metric.
`java.lang.String`	`getRegion()` Region which this metric comes from.
`java.lang.String`	`getStatistic()` Statistic of this metric.
`Unit`	`getUnit()` Unit of the metric.
`java.util.List<java.lang.String>`	`getWarnings()` Warnings attached to this metric.
`static Grant`	`grantPutMetricData(IGrantable grantee)` Grant permissions to the given identity to write metrics.
`MetricAlarmConfig`	`toAlarmConfig()` Deprecated. use toMetricConfig()
`MetricGraphConfig`	`toGraphConfig()` Deprecated. use toMetricConfig()
`MetricConfig`	`toMetricConfig()` Inspect the details of the metric object.
`java.lang.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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Metric
```
protected Metric(software.amazon.jsii.JsiiObjectRef objRef)
```
  - Metric
```
protected Metric(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
- Method Detail
  - grantPutMetricData
```
public static Grant grantPutMetricData(IGrantable grantee)
```
    Grant permissions to the given identity to write metrics.
    
    Parameters:
    
    grantee - The IAM identity to give permissions to. This parameter is required.
  - attachTo
```
public Metric attachTo(software.constructs.IConstruct scope)
```
    Attach the metric object to the given construct scope.
    Returns a Metric object that uses the account and region from the Stack the given construct is defined in. If the metric is subsequently used in a Dashboard or Alarm in a different Stack defined in a different account or region, the appropriate 'region' and 'account' fields will be added to it.
    If the scope we attach to is in an environment-agnostic stack, nothing is done and the same Metric object is returned.
    
    Parameters:
    
    scope - This parameter is required.
  - createAlarm
```
public Alarm createAlarm(Construct scope,
                         java.lang.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.
    
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    props - This parameter is required.
  - toAlarmConfig
```
@Deprecated
public MetricAlarmConfig toAlarmConfig()
```
    Deprecated. use toMetricConfig()
    
    (deprecated) Turn this metric object into an alarm configuration.
    
    Specified by:
    
    toAlarmConfig in interface IMetric
  - toGraphConfig
```
@Deprecated
public MetricGraphConfig toGraphConfig()
```
    Deprecated. use toMetricConfig()
    
    (deprecated) Turn this metric object into a graph configuration.
    
    Specified by:
    
    toGraphConfig in interface IMetric
  - toMetricConfig
```
public MetricConfig toMetricConfig()
```
    Inspect the details of the metric object.
    
    Specified by:
    
    toMetricConfig in interface IMetric
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of an object.
  - with
```
public Metric with(MetricOptions props)
```
    Return a copy of Metric `with` properties changed.
    All properties except namespace and metricName can be changed.
    
    Parameters:
    
    props - The set of properties to change. This parameter is required.
  - getMetricName
```
public java.lang.String getMetricName()
```
    Name of this metric.
  - getNamespace
```
public java.lang.String getNamespace()
```
    Namespace of this metric.
  - getPeriod
```
public Duration getPeriod()
```
    Period of this metric.
  - getStatistic
```
public java.lang.String getStatistic()
```
    Statistic of this metric.
  - getAccount
```
public java.lang.String getAccount()
```
    Account which this metric comes from.
  - getColor
```
public java.lang.String getColor()
```
    The hex color code used when this metric is rendered on a graph.
  - getDimensions
```
public java.util.Map<java.lang.String,java.lang.Object> getDimensions()
```
    Dimensions of this metric.
  - getLabel
```
public java.lang.String getLabel()
```
    Label for this metric when added to a Graph in a Dashboard.
  - getRegion
```
public java.lang.String getRegion()
```
    Region which this metric comes from.
  - getUnit
```
public Unit getUnit()
```
    Unit of the metric.
  - getWarnings
```
public java.util.List<java.lang.String> getWarnings()
```
    Warnings attached to this metric.
    
    Specified by:
    
    getWarnings in interface IMetric

Class Metric

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Metric

Metric

Method Detail

grantPutMetricData

attachTo

createAlarm

toAlarmConfig

toGraphConfig

toMetricConfig

toString

with

getMetricName

getNamespace

getPeriod

getStatistic

getAccount

getColor

getDimensions

getLabel

getRegion

getUnit

getWarnings