interface MetricGraphConfig
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.CloudWatch.MetricGraphConfig |
Java | software.amazon.awscdk.services.cloudwatch.MetricGraphConfig |
Python | aws_cdk.aws_cloudwatch.MetricGraphConfig |
TypeScript (source) | @aws-cdk/aws-cloudwatch » MetricGraphConfig |
⚠️ Deprecated: Replaced by MetricConfig
Obtainable from
Math
.toGraphConfig()
, Metric
.toGraphConfig()
Properties used to construct the Metric identifying part of a Graph.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cloudwatch from '@aws-cdk/aws-cloudwatch';
declare const value: any;
const metricGraphConfig: cloudwatch.MetricGraphConfig = {
metricName: 'metricName',
namespace: 'namespace',
period: 123,
renderingProperties: {
period: 123,
// the properties below are optional
color: 'color',
label: 'label',
stat: 'stat',
},
// the properties below are optional
color: 'color',
dimensions: [{
name: 'name',
value: value,
}],
label: 'label',
statistic: 'statistic',
unit: cloudwatch.Unit.SECONDS,
};
Properties
Name | Type | Description |
---|---|---|
metric | string | Name of the metric. |
namespace | string | Namespace of the metric. |
period | number | How many seconds to aggregate over. |
rendering | Metric | Rendering properties override yAxis parameter of the widget object. |
color? | string | Color for the graph line. |
dimensions? | Dimension [] | The dimensions to apply to the alarm. |
label? | string | Label for the metric. |
statistic? | string | Aggregation function to use (can be either simple or a percentile). |
unit? | Unit | The unit of the alarm. |
metricName
⚠️ Deprecated: Replaced by MetricConfig
Type:
string
Name of the metric.
namespace
⚠️ Deprecated: Replaced by MetricConfig
Type:
string
Namespace of the metric.
period
⚠️ Deprecated: Use period
in renderingProperties
Type:
number
How many seconds to aggregate over.
renderingProperties
⚠️ Deprecated: Replaced by MetricConfig
Type:
Metric
Rendering properties override yAxis parameter of the widget object.
color?
⚠️ Deprecated: Use color
in renderingProperties
Type:
string
(optional)
Color for the graph line.
dimensions?
⚠️ Deprecated: Replaced by MetricConfig
Type:
Dimension
[]
(optional)
The dimensions to apply to the alarm.
label?
⚠️ Deprecated: Use label
in renderingProperties
Type:
string
(optional)
Label for the metric.
statistic?
⚠️ Deprecated: Use stat
in renderingProperties
Type:
string
(optional)
Aggregation function to use (can be either simple or a percentile).
unit?
⚠️ Deprecated: not used in dashboard widgets
Type:
Unit
(optional)
The unit of the alarm.