-
Notifications
You must be signed in to change notification settings - Fork 17
/
CommonMetricOptions.go
98 lines (95 loc) · 3.38 KB
/
CommonMetricOptions.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
package awscloudwatch
import (
"github.com/aws/aws-cdk-go/awscdk/v2"
)
// Options shared by most methods accepting metric options.
//
// Example:
// // The code below shows an example of how to instantiate this type.
// // The values are placeholders you should change.
// import cdk "github.com/aws/aws-cdk-go/awscdk"
// import "github.com/aws/aws-cdk-go/awscdk"
//
// commonMetricOptions := &CommonMetricOptions{
// Account: jsii.String("account"),
// Color: jsii.String("color"),
// DimensionsMap: map[string]*string{
// "dimensionsMapKey": jsii.String("dimensionsMap"),
// },
// Label: jsii.String("label"),
// Period: cdk.Duration_Minutes(jsii.Number(30)),
// Region: jsii.String("region"),
// Statistic: jsii.String("statistic"),
// Unit: awscdk.Aws_cloudwatch.Unit_SECONDS,
// }
//
type CommonMetricOptions struct {
// Account which this metric comes from.
// Default: - Deployment account.
//
Account *string `field:"optional" json:"account" yaml:"account"`
// The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The `Color` class has a set of standard colors that can be used here.
// Default: - Automatic color.
//
Color *string `field:"optional" json:"color" yaml:"color"`
// Dimensions of the metric.
// Default: - No dimensions.
//
DimensionsMap *map[string]*string `field:"optional" json:"dimensionsMap" yaml:"dimensionsMap"`
// Label for this metric when added to a Graph in a Dashboard.
//
// You can use [dynamic labels](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html)
// to show summary information about the entire displayed time series
// in the legend. For example, if you use:
//
// ```
// [max: ${MAX}] MyMetric
// ```
//
// As the metric label, the maximum value in the visible range will
// be shown next to the time series name in the graph's legend.
// Default: - No label.
//
Label *string `field:"optional" json:"label" yaml:"label"`
// The period over which the specified statistic is applied.
// Default: Duration.minutes(5)
//
Period awscdk.Duration `field:"optional" json:"period" yaml:"period"`
// Region which this metric comes from.
// Default: - Deployment region.
//
Region *string `field:"optional" json:"region" yaml:"region"`
// What function to use for aggregating.
//
// Use the `aws_cloudwatch.Stats` helper class to construct valid input strings.
//
// Can be one of the following:
//
// - "Minimum" | "min"
// - "Maximum" | "max"
// - "Average" | "avg"
// - "Sum" | "sum"
// - "SampleCount | "n"
// - "pNN.NN"
// - "tmNN.NN" | "tm(NN.NN%:NN.NN%)"
// - "iqm"
// - "wmNN.NN" | "wm(NN.NN%:NN.NN%)"
// - "tcNN.NN" | "tc(NN.NN%:NN.NN%)"
// - "tsNN.NN" | "ts(NN.NN%:NN.NN%)"
// Default: Average.
//
Statistic *string `field:"optional" json:"statistic" yaml:"statistic"`
// Unit used to filter the metric stream.
//
// Only refer to datums emitted to the metric stream with the given unit and
// ignore all others. Only useful when datums are being emitted to the same
// metric stream under different units.
//
// The default is to use all matric datums in the stream, regardless of unit,
// which is recommended in nearly all cases.
//
// CloudWatch does not honor this property for graphs.
// Default: - All metric datums in the given metric stream.
//
Unit Unit `field:"optional" json:"unit" yaml:"unit"`
}