1 | import * as cdk from '@aws-cdk/core';
|
2 | import * as cfn_parse from '@aws-cdk/core/lib/helpers-internal';
|
3 | /**
|
4 | * Properties for defining a `CfnAlarm`
|
5 | *
|
6 | * @struct
|
7 | * @stability external
|
8 | *
|
9 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html
|
10 | */
|
11 | export interface CfnAlarmProps {
|
12 | /**
|
13 | * The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
|
14 | *
|
15 | * You can specify the following values: `GreaterThanThreshold` , `GreaterThanOrEqualToThreshold` , `LessThanThreshold` , or `LessThanOrEqualToThreshold` .
|
16 | *
|
17 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-comparisonoperator
|
18 | */
|
19 | readonly comparisonOperator: string;
|
20 | /**
|
21 | * The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and `DatapointsToAlarm` is the M.
|
22 | *
|
23 | * For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *Amazon CloudWatch User Guide* .
|
24 | *
|
25 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-evaluationperiods
|
26 | */
|
27 | readonly evaluationPeriods: number;
|
28 | /**
|
29 | * Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
|
30 | *
|
31 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-actionsenabled
|
32 | */
|
33 | readonly actionsEnabled?: boolean | cdk.IResolvable;
|
34 | /**
|
35 | * The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *Amazon CloudWatch API Reference* .
|
36 | *
|
37 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-alarmactions
|
38 | */
|
39 | readonly alarmActions?: string[];
|
40 | /**
|
41 | * The description of the alarm.
|
42 | *
|
43 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-alarmdescription
|
44 | */
|
45 | readonly alarmDescription?: string;
|
46 | /**
|
47 | * The name of the alarm. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the alarm name.
|
48 | *
|
49 | * > If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
|
50 | *
|
51 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-alarmname
|
52 | */
|
53 | readonly alarmName?: string;
|
54 | /**
|
55 | * The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for `EvaluationPeriods` is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *Amazon CloudWatch User Guide* .
|
56 | *
|
57 | * If you omit this parameter, CloudWatch uses the same value here that you set for `EvaluationPeriods` , and the alarm goes to alarm state if that many consecutive periods are breaching.
|
58 | *
|
59 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-datapointstoalarm
|
60 | */
|
61 | readonly datapointsToAlarm?: number;
|
62 | /**
|
63 | * The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify `Dimensions` . Instead, you use `Metrics` .
|
64 | *
|
65 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-dimension
|
66 | */
|
67 | readonly dimensions?: Array<CfnAlarm.DimensionProperty | cdk.IResolvable> | cdk.IResolvable;
|
68 | /**
|
69 | * Used only for alarms based on percentiles. If `ignore` , the alarm state does not change during periods with too few data points to be statistically significant. If `evaluate` or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
|
70 | *
|
71 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-evaluatelowsamplecountpercentile
|
72 | */
|
73 | readonly evaluateLowSampleCountPercentile?: string;
|
74 | /**
|
75 | * The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
|
76 | *
|
77 | * For an alarm based on a metric, you must specify either `Statistic` or `ExtendedStatistic` but not both.
|
78 | *
|
79 | * For an alarm based on a math expression, you can't specify `ExtendedStatistic` . Instead, you use `Metrics` .
|
80 | *
|
81 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-extendedstatistic
|
82 | */
|
83 | readonly extendedStatistic?: string;
|
84 | /**
|
85 | * The actions to execute when this alarm transitions to the `INSUFFICIENT_DATA` state from any other state. Each action is specified as an Amazon Resource Name (ARN).
|
86 | *
|
87 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-insufficientdataactions
|
88 | */
|
89 | readonly insufficientDataActions?: string[];
|
90 | /**
|
91 | * The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use `Metrics` instead and you can't specify `MetricName` .
|
92 | *
|
93 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-metricname
|
94 | */
|
95 | readonly metricName?: string;
|
96 | /**
|
97 | * An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression.
|
98 | *
|
99 | * If you specify the `Metrics` parameter, you cannot specify `MetricName` , `Dimensions` , `Period` , `Namespace` , `Statistic` , `ExtendedStatistic` , or `Unit` .
|
100 | *
|
101 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-metrics
|
102 | */
|
103 | readonly metrics?: Array<CfnAlarm.MetricDataQueryProperty | cdk.IResolvable> | cdk.IResolvable;
|
104 | /**
|
105 | * The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify `Namespace` and you use `Metrics` instead.
|
106 | *
|
107 | * For a list of namespaces for metrics from AWS services, see [AWS Services That Publish CloudWatch Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)
|
108 | *
|
109 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-namespace
|
110 | */
|
111 | readonly namespace?: string;
|
112 | /**
|
113 | * The actions to execute when this alarm transitions to the `OK` state from any other state. Each action is specified as an Amazon Resource Name (ARN).
|
114 | *
|
115 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-okactions
|
116 | */
|
117 | readonly okActions?: string[];
|
118 | /**
|
119 | * The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.
|
120 | *
|
121 | * For an alarm based on a math expression, you can't specify `Period` , and instead you use the `Metrics` parameter.
|
122 | *
|
123 | * *Minimum:* 10
|
124 | *
|
125 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-period
|
126 | */
|
127 | readonly period?: number;
|
128 | /**
|
129 | * The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use `ExtendedStatistic` .
|
130 | *
|
131 | * For an alarm based on a metric, you must specify either `Statistic` or `ExtendedStatistic` but not both.
|
132 | *
|
133 | * For an alarm based on a math expression, you can't specify `Statistic` . Instead, you use `Metrics` .
|
134 | *
|
135 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-statistic
|
136 | */
|
137 | readonly statistic?: string;
|
138 | /**
|
139 | * The value to compare with the specified statistic.
|
140 | *
|
141 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-threshold
|
142 | */
|
143 | readonly threshold?: number;
|
144 | /**
|
145 | * In an alarm based on an anomaly detection model, this is the ID of the `ANOMALY_DETECTION_BAND` function used as the threshold for the alarm.
|
146 | *
|
147 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-dynamic-threshold
|
148 | */
|
149 | readonly thresholdMetricId?: string;
|
150 | /**
|
151 | * Sets how this alarm is to handle missing data points. Valid values are `breaching` , `notBreaching` , `ignore` , and `missing` . For more information, see [Configuring How CloudWatch Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon CloudWatch User Guide* .
|
152 | *
|
153 | * If you omit this parameter, the default behavior of `missing` is used.
|
154 | *
|
155 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-treatmissingdata
|
156 | */
|
157 | readonly treatMissingData?: string;
|
158 | /**
|
159 | * The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a `Metrics` array.
|
160 | *
|
161 | * You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
|
162 | *
|
163 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-unit
|
164 | */
|
165 | readonly unit?: string;
|
166 | }
|
167 | /**
|
168 | * A CloudFormation `AWS::CloudWatch::Alarm`
|
169 | *
|
170 | * The `AWS::CloudWatch::Alarm` type specifies an alarm and associates it with the specified metric or metric math expression.
|
171 | *
|
172 | * When this operation creates an alarm, the alarm state is immediately set to `INSUFFICIENT_DATA` . The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.
|
173 | *
|
174 | * When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
|
175 | *
|
176 | * @cloudformationResource AWS::CloudWatch::Alarm
|
177 | * @stability external
|
178 | *
|
179 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html
|
180 | */
|
181 | export declare class CfnAlarm extends cdk.CfnResource implements cdk.IInspectable {
|
182 | /**
|
183 | * The CloudFormation resource type name for this resource class.
|
184 | */
|
185 | static readonly CFN_RESOURCE_TYPE_NAME = "AWS::CloudWatch::Alarm";
|
186 | /**
|
187 | * A factory method that creates a new instance of this class from an object
|
188 | * containing the CloudFormation properties of this resource.
|
189 | * Used in the @aws-cdk/cloudformation-include module.
|
190 | *
|
191 | * @internal
|
192 | */
|
193 | static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnAlarm;
|
194 | /**
|
195 | * The ARN of the CloudWatch alarm, such as `arn:aws:cloudwatch:us-west-2:123456789012:alarm:myCloudWatchAlarm-CPUAlarm-UXMMZK36R55Z` .
|
196 | * @cloudformationAttribute Arn
|
197 | */
|
198 | readonly attrArn: string;
|
199 | /**
|
200 | * The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
|
201 | *
|
202 | * You can specify the following values: `GreaterThanThreshold` , `GreaterThanOrEqualToThreshold` , `LessThanThreshold` , or `LessThanOrEqualToThreshold` .
|
203 | *
|
204 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-comparisonoperator
|
205 | */
|
206 | comparisonOperator: string;
|
207 | /**
|
208 | * The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and `DatapointsToAlarm` is the M.
|
209 | *
|
210 | * For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *Amazon CloudWatch User Guide* .
|
211 | *
|
212 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-evaluationperiods
|
213 | */
|
214 | evaluationPeriods: number;
|
215 | /**
|
216 | * Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
|
217 | *
|
218 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-actionsenabled
|
219 | */
|
220 | actionsEnabled: boolean | cdk.IResolvable | undefined;
|
221 | /**
|
222 | * The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *Amazon CloudWatch API Reference* .
|
223 | *
|
224 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-alarmactions
|
225 | */
|
226 | alarmActions: string[] | undefined;
|
227 | /**
|
228 | * The description of the alarm.
|
229 | *
|
230 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-alarmdescription
|
231 | */
|
232 | alarmDescription: string | undefined;
|
233 | /**
|
234 | * The name of the alarm. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the alarm name.
|
235 | *
|
236 | * > If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
|
237 | *
|
238 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-alarmname
|
239 | */
|
240 | alarmName: string | undefined;
|
241 | /**
|
242 | * The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for `EvaluationPeriods` is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *Amazon CloudWatch User Guide* .
|
243 | *
|
244 | * If you omit this parameter, CloudWatch uses the same value here that you set for `EvaluationPeriods` , and the alarm goes to alarm state if that many consecutive periods are breaching.
|
245 | *
|
246 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-datapointstoalarm
|
247 | */
|
248 | datapointsToAlarm: number | undefined;
|
249 | /**
|
250 | * The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify `Dimensions` . Instead, you use `Metrics` .
|
251 | *
|
252 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-dimension
|
253 | */
|
254 | dimensions: Array<CfnAlarm.DimensionProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
|
255 | /**
|
256 | * Used only for alarms based on percentiles. If `ignore` , the alarm state does not change during periods with too few data points to be statistically significant. If `evaluate` or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
|
257 | *
|
258 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-evaluatelowsamplecountpercentile
|
259 | */
|
260 | evaluateLowSampleCountPercentile: string | undefined;
|
261 | /**
|
262 | * The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
|
263 | *
|
264 | * For an alarm based on a metric, you must specify either `Statistic` or `ExtendedStatistic` but not both.
|
265 | *
|
266 | * For an alarm based on a math expression, you can't specify `ExtendedStatistic` . Instead, you use `Metrics` .
|
267 | *
|
268 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-extendedstatistic
|
269 | */
|
270 | extendedStatistic: string | undefined;
|
271 | /**
|
272 | * The actions to execute when this alarm transitions to the `INSUFFICIENT_DATA` state from any other state. Each action is specified as an Amazon Resource Name (ARN).
|
273 | *
|
274 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-insufficientdataactions
|
275 | */
|
276 | insufficientDataActions: string[] | undefined;
|
277 | /**
|
278 | * The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use `Metrics` instead and you can't specify `MetricName` .
|
279 | *
|
280 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-metricname
|
281 | */
|
282 | metricName: string | undefined;
|
283 | /**
|
284 | * An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression.
|
285 | *
|
286 | * If you specify the `Metrics` parameter, you cannot specify `MetricName` , `Dimensions` , `Period` , `Namespace` , `Statistic` , `ExtendedStatistic` , or `Unit` .
|
287 | *
|
288 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-metrics
|
289 | */
|
290 | metrics: Array<CfnAlarm.MetricDataQueryProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
|
291 | /**
|
292 | * The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify `Namespace` and you use `Metrics` instead.
|
293 | *
|
294 | * For a list of namespaces for metrics from AWS services, see [AWS Services That Publish CloudWatch Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)
|
295 | *
|
296 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-namespace
|
297 | */
|
298 | namespace: string | undefined;
|
299 | /**
|
300 | * The actions to execute when this alarm transitions to the `OK` state from any other state. Each action is specified as an Amazon Resource Name (ARN).
|
301 | *
|
302 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-okactions
|
303 | */
|
304 | okActions: string[] | undefined;
|
305 | /**
|
306 | * The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.
|
307 | *
|
308 | * For an alarm based on a math expression, you can't specify `Period` , and instead you use the `Metrics` parameter.
|
309 | *
|
310 | * *Minimum:* 10
|
311 | *
|
312 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-period
|
313 | */
|
314 | period: number | undefined;
|
315 | /**
|
316 | * The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use `ExtendedStatistic` .
|
317 | *
|
318 | * For an alarm based on a metric, you must specify either `Statistic` or `ExtendedStatistic` but not both.
|
319 | *
|
320 | * For an alarm based on a math expression, you can't specify `Statistic` . Instead, you use `Metrics` .
|
321 | *
|
322 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-statistic
|
323 | */
|
324 | statistic: string | undefined;
|
325 | /**
|
326 | * The value to compare with the specified statistic.
|
327 | *
|
328 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-threshold
|
329 | */
|
330 | threshold: number | undefined;
|
331 | /**
|
332 | * In an alarm based on an anomaly detection model, this is the ID of the `ANOMALY_DETECTION_BAND` function used as the threshold for the alarm.
|
333 | *
|
334 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-dynamic-threshold
|
335 | */
|
336 | thresholdMetricId: string | undefined;
|
337 | /**
|
338 | * Sets how this alarm is to handle missing data points. Valid values are `breaching` , `notBreaching` , `ignore` , and `missing` . For more information, see [Configuring How CloudWatch Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon CloudWatch User Guide* .
|
339 | *
|
340 | * If you omit this parameter, the default behavior of `missing` is used.
|
341 | *
|
342 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-treatmissingdata
|
343 | */
|
344 | treatMissingData: string | undefined;
|
345 | /**
|
346 | * The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a `Metrics` array.
|
347 | *
|
348 | * You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
|
349 | *
|
350 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarms-unit
|
351 | */
|
352 | unit: string | undefined;
|
353 | /**
|
354 | * Create a new `AWS::CloudWatch::Alarm`.
|
355 | *
|
356 | * @param scope - scope in which this resource is defined
|
357 | * @param id - scoped id of the resource
|
358 | * @param props - resource properties
|
359 | */
|
360 | constructor(scope: cdk.Construct, id: string, props: CfnAlarmProps);
|
361 | /**
|
362 | * Examines the CloudFormation resource and discloses attributes.
|
363 | *
|
364 | * @param inspector - tree inspector to collect and process attributes
|
365 | *
|
366 | */
|
367 | inspect(inspector: cdk.TreeInspector): void;
|
368 | protected get cfnProperties(): {
|
369 | [key: string]: any;
|
370 | };
|
371 | protected renderProperties(props: {
|
372 | [key: string]: any;
|
373 | }): {
|
374 | [key: string]: any;
|
375 | };
|
376 | }
|
377 | export declare namespace CfnAlarm {
|
378 | /**
|
379 | * Dimension is an embedded property of the `AWS::CloudWatch::Alarm` type. Dimensions are name/value pairs that can be associated with a CloudWatch metric. You can specify a maximum of 10 dimensions for a given metric.
|
380 | *
|
381 | * @struct
|
382 | * @stability external
|
383 | *
|
384 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html
|
385 | */
|
386 | interface DimensionProperty {
|
387 | /**
|
388 | * The name of the dimension, from 1–255 characters in length. This dimension name must have been included when the metric was published.
|
389 | *
|
390 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html#cfn-cloudwatch-alarm-dimension-name
|
391 | */
|
392 | readonly name: string;
|
393 | /**
|
394 | * The value for the dimension, from 1–255 characters in length.
|
395 | *
|
396 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html#cfn-cloudwatch-alarm-dimension-value
|
397 | */
|
398 | readonly value: string;
|
399 | }
|
400 | }
|
401 | export declare namespace CfnAlarm {
|
402 | /**
|
403 | * The `Metric` property type represents a specific metric. `Metric` is a property of the [MetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html) property type.
|
404 | *
|
405 | * @struct
|
406 | * @stability external
|
407 | *
|
408 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html
|
409 | */
|
410 | interface MetricProperty {
|
411 | /**
|
412 | * The metric dimensions that you want to be used for the metric that the alarm will watch.
|
413 | *
|
414 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html#cfn-cloudwatch-alarm-metric-dimensions
|
415 | */
|
416 | readonly dimensions?: Array<CfnAlarm.DimensionProperty | cdk.IResolvable> | cdk.IResolvable;
|
417 | /**
|
418 | * The name of the metric that you want the alarm to watch. This is a required field.
|
419 | *
|
420 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html#cfn-cloudwatch-alarm-metric-metricname
|
421 | */
|
422 | readonly metricName?: string;
|
423 | /**
|
424 | * The namespace of the metric that the alarm will watch.
|
425 | *
|
426 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html#cfn-cloudwatch-alarm-metric-namespace
|
427 | */
|
428 | readonly namespace?: string;
|
429 | }
|
430 | }
|
431 | export declare namespace CfnAlarm {
|
432 | /**
|
433 | * The `MetricDataQuery` property type specifies the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data.
|
434 | *
|
435 | * Any expression used must return a single time series. For more information, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide* .
|
436 | *
|
437 | * @struct
|
438 | * @stability external
|
439 | *
|
440 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html
|
441 | */
|
442 | interface MetricDataQueryProperty {
|
443 | /**
|
444 | * The ID of the account where the metrics are located, if this is a cross-account alarm.
|
445 | *
|
446 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-accountid
|
447 | */
|
448 | readonly accountId?: string;
|
449 | /**
|
450 | * The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the `Id` of the other metrics to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide* .
|
451 | *
|
452 | * Within each MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both.
|
453 | *
|
454 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-expression
|
455 | */
|
456 | readonly expression?: string;
|
457 | /**
|
458 | * A short name used to tie this object to the results in the response. This name must be unique within a single call to `GetMetricData` . If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
|
459 | *
|
460 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-id
|
461 | */
|
462 | readonly id: string;
|
463 | /**
|
464 | * A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If `Label` is omitted, CloudWatch generates a default.
|
465 | *
|
466 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-label
|
467 | */
|
468 | readonly label?: string;
|
469 | /**
|
470 | * The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
|
471 | *
|
472 | * Within one MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both.
|
473 | *
|
474 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-metricstat
|
475 | */
|
476 | readonly metricStat?: CfnAlarm.MetricStatProperty | cdk.IResolvable;
|
477 | /**
|
478 | * The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a `PutMetricData` operation that includes a `StorageResolution of 1 second` .
|
479 | */
|
480 | readonly period?: number;
|
481 | /**
|
482 | * This option indicates whether to return the timestamps and raw data values of this metric.
|
483 | *
|
484 | * When you create an alarm based on a metric math expression, specify `True` for this value for only the one math expression that the alarm is based on. You must specify `False` for `ReturnData` for all the other metrics and expressions used in the alarm.
|
485 | *
|
486 | * This field is required.
|
487 | *
|
488 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-returndata
|
489 | */
|
490 | readonly returnData?: boolean | cdk.IResolvable;
|
491 | }
|
492 | }
|
493 | export declare namespace CfnAlarm {
|
494 | /**
|
495 | * This structure defines the metric to be returned, along with the statistics, period, and units.
|
496 | *
|
497 | * `MetricStat` is a property of the [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html) property type.
|
498 | *
|
499 | * @struct
|
500 | * @stability external
|
501 | *
|
502 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html
|
503 | */
|
504 | interface MetricStatProperty {
|
505 | /**
|
506 | * The metric to return, including the metric name, namespace, and dimensions.
|
507 | *
|
508 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html#cfn-cloudwatch-alarm-metricstat-metric
|
509 | */
|
510 | readonly metric: CfnAlarm.MetricProperty | cdk.IResolvable;
|
511 | /**
|
512 | * The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a `PutMetricData` call that includes a `StorageResolution` of 1 second.
|
513 | *
|
514 | * If the `StartTime` parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
|
515 | *
|
516 | * - Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
|
517 | * - Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
|
518 | * - Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
|
519 | *
|
520 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html#cfn-cloudwatch-alarm-metricstat-period
|
521 | */
|
522 | readonly period: number;
|
523 | /**
|
524 | * The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *Amazon CloudWatch User Guide* .
|
525 | *
|
526 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html#cfn-cloudwatch-alarm-metricstat-stat
|
527 | */
|
528 | readonly stat: string;
|
529 | /**
|
530 | * The unit to use for the returned data points.
|
531 | *
|
532 | * Valid values are: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
|
533 | *
|
534 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html#cfn-cloudwatch-alarm-metricstat-unit
|
535 | */
|
536 | readonly unit?: string;
|
537 | }
|
538 | }
|
539 | /**
|
540 | * Properties for defining a `CfnAnomalyDetector`
|
541 | *
|
542 | * @struct
|
543 | * @stability external
|
544 | *
|
545 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html
|
546 | */
|
547 | export interface CfnAnomalyDetectorProps {
|
548 | /**
|
549 | * Specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model. The configuration can also include the time zone to use for the metric.
|
550 | *
|
551 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-configuration
|
552 | */
|
553 | readonly configuration?: CfnAnomalyDetector.ConfigurationProperty | cdk.IResolvable;
|
554 | /**
|
555 | * The dimensions of the metric associated with the anomaly detection band.
|
556 | *
|
557 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-dimensions
|
558 | */
|
559 | readonly dimensions?: Array<CfnAnomalyDetector.DimensionProperty | cdk.IResolvable> | cdk.IResolvable;
|
560 | /**
|
561 | * The CloudWatch metric math expression for this anomaly detector.
|
562 | *
|
563 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-metricmathanomalydetector
|
564 | */
|
565 | readonly metricMathAnomalyDetector?: CfnAnomalyDetector.MetricMathAnomalyDetectorProperty | cdk.IResolvable;
|
566 | /**
|
567 | * The name of the metric associated with the anomaly detection band.
|
568 | *
|
569 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-metricname
|
570 | */
|
571 | readonly metricName?: string;
|
572 | /**
|
573 | * The namespace of the metric associated with the anomaly detection band.
|
574 | *
|
575 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-namespace
|
576 | */
|
577 | readonly namespace?: string;
|
578 | /**
|
579 | * The CloudWatch metric and statistic for this anomaly detector.
|
580 | *
|
581 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-singlemetricanomalydetector
|
582 | */
|
583 | readonly singleMetricAnomalyDetector?: CfnAnomalyDetector.SingleMetricAnomalyDetectorProperty | cdk.IResolvable;
|
584 | /**
|
585 | * The statistic of the metric associated with the anomaly detection band.
|
586 | *
|
587 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-stat
|
588 | */
|
589 | readonly stat?: string;
|
590 | }
|
591 | /**
|
592 | * A CloudFormation `AWS::CloudWatch::AnomalyDetector`
|
593 | *
|
594 | * The `AWS::CloudWatch::AnomalyDetector` type specifies an anomaly detection band for a certain metric and statistic. The band represents the expected "normal" range for the metric values. Anomaly detection bands can be used for visualization of a metric's expected values, and for alarms.
|
595 | *
|
596 | * @cloudformationResource AWS::CloudWatch::AnomalyDetector
|
597 | * @stability external
|
598 | *
|
599 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html
|
600 | */
|
601 | export declare class CfnAnomalyDetector extends cdk.CfnResource implements cdk.IInspectable {
|
602 | /**
|
603 | * The CloudFormation resource type name for this resource class.
|
604 | */
|
605 | static readonly CFN_RESOURCE_TYPE_NAME = "AWS::CloudWatch::AnomalyDetector";
|
606 | /**
|
607 | * A factory method that creates a new instance of this class from an object
|
608 | * containing the CloudFormation properties of this resource.
|
609 | * Used in the @aws-cdk/cloudformation-include module.
|
610 | *
|
611 | * @internal
|
612 | */
|
613 | static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnAnomalyDetector;
|
614 | /**
|
615 | * Specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model. The configuration can also include the time zone to use for the metric.
|
616 | *
|
617 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-configuration
|
618 | */
|
619 | configuration: CfnAnomalyDetector.ConfigurationProperty | cdk.IResolvable | undefined;
|
620 | /**
|
621 | * The dimensions of the metric associated with the anomaly detection band.
|
622 | *
|
623 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-dimensions
|
624 | */
|
625 | dimensions: Array<CfnAnomalyDetector.DimensionProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
|
626 | /**
|
627 | * The CloudWatch metric math expression for this anomaly detector.
|
628 | *
|
629 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-metricmathanomalydetector
|
630 | */
|
631 | metricMathAnomalyDetector: CfnAnomalyDetector.MetricMathAnomalyDetectorProperty | cdk.IResolvable | undefined;
|
632 | /**
|
633 | * The name of the metric associated with the anomaly detection band.
|
634 | *
|
635 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-metricname
|
636 | */
|
637 | metricName: string | undefined;
|
638 | /**
|
639 | * The namespace of the metric associated with the anomaly detection band.
|
640 | *
|
641 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-namespace
|
642 | */
|
643 | namespace: string | undefined;
|
644 | /**
|
645 | * The CloudWatch metric and statistic for this anomaly detector.
|
646 | *
|
647 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-singlemetricanomalydetector
|
648 | */
|
649 | singleMetricAnomalyDetector: CfnAnomalyDetector.SingleMetricAnomalyDetectorProperty | cdk.IResolvable | undefined;
|
650 | /**
|
651 | * The statistic of the metric associated with the anomaly detection band.
|
652 | *
|
653 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-stat
|
654 | */
|
655 | stat: string | undefined;
|
656 | /**
|
657 | * Create a new `AWS::CloudWatch::AnomalyDetector`.
|
658 | *
|
659 | * @param scope - scope in which this resource is defined
|
660 | * @param id - scoped id of the resource
|
661 | * @param props - resource properties
|
662 | */
|
663 | constructor(scope: cdk.Construct, id: string, props?: CfnAnomalyDetectorProps);
|
664 | /**
|
665 | * Examines the CloudFormation resource and discloses attributes.
|
666 | *
|
667 | * @param inspector - tree inspector to collect and process attributes
|
668 | *
|
669 | */
|
670 | inspect(inspector: cdk.TreeInspector): void;
|
671 | protected get cfnProperties(): {
|
672 | [key: string]: any;
|
673 | };
|
674 | protected renderProperties(props: {
|
675 | [key: string]: any;
|
676 | }): {
|
677 | [key: string]: any;
|
678 | };
|
679 | }
|
680 | export declare namespace CfnAnomalyDetector {
|
681 | /**
|
682 | * Specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model. The configuration can also include the time zone to use for the metric.
|
683 | *
|
684 | * @struct
|
685 | * @stability external
|
686 | *
|
687 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-configuration.html
|
688 | */
|
689 | interface ConfigurationProperty {
|
690 | /**
|
691 | * Specifies an array of time ranges to exclude from use when the anomaly detection model is trained and updated. Use this to make sure that events that could cause unusual values for the metric, such as deployments, aren't used when CloudWatch creates or updates the model.
|
692 | *
|
693 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-configuration.html#cfn-cloudwatch-anomalydetector-configuration-excludedtimeranges
|
694 | */
|
695 | readonly excludedTimeRanges?: Array<CfnAnomalyDetector.RangeProperty | cdk.IResolvable> | cdk.IResolvable;
|
696 | /**
|
697 | * The time zone to use for the metric. This is useful to enable the model to automatically account for daylight savings time changes if the metric is sensitive to such time changes.
|
698 | *
|
699 | * To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, see [tz database](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Tz_database) .
|
700 | *
|
701 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-configuration.html#cfn-cloudwatch-anomalydetector-configuration-metrictimezone
|
702 | */
|
703 | readonly metricTimeZone?: string;
|
704 | }
|
705 | }
|
706 | export declare namespace CfnAnomalyDetector {
|
707 | /**
|
708 | * A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish `InstanceId` as a dimension name, and the actual instance ID as the value for that dimension.
|
709 | *
|
710 | * You can assign up to 30 dimensions to a metric.
|
711 | *
|
712 | * @struct
|
713 | * @stability external
|
714 | *
|
715 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html
|
716 | */
|
717 | interface DimensionProperty {
|
718 | /**
|
719 | * The name of the dimension.
|
720 | *
|
721 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html#cfn-cloudwatch-anomalydetector-dimension-name
|
722 | */
|
723 | readonly name: string;
|
724 | /**
|
725 | * The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.
|
726 | *
|
727 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html#cfn-cloudwatch-anomalydetector-dimension-value
|
728 | */
|
729 | readonly value: string;
|
730 | }
|
731 | }
|
732 | export declare namespace CfnAnomalyDetector {
|
733 | /**
|
734 | * Represents a specific metric.
|
735 | *
|
736 | * @struct
|
737 | * @stability external
|
738 | *
|
739 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metric.html
|
740 | */
|
741 | interface MetricProperty {
|
742 | /**
|
743 | * The dimensions for the metric.
|
744 | *
|
745 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metric.html#cfn-cloudwatch-anomalydetector-metric-dimensions
|
746 | */
|
747 | readonly dimensions?: Array<CfnAnomalyDetector.DimensionProperty | cdk.IResolvable> | cdk.IResolvable;
|
748 | /**
|
749 | * The name of the metric. This is a required field.
|
750 | *
|
751 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metric.html#cfn-cloudwatch-anomalydetector-metric-metricname
|
752 | */
|
753 | readonly metricName: string;
|
754 | /**
|
755 | * The namespace of the metric.
|
756 | *
|
757 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metric.html#cfn-cloudwatch-anomalydetector-metric-namespace
|
758 | */
|
759 | readonly namespace: string;
|
760 | }
|
761 | }
|
762 | export declare namespace CfnAnomalyDetector {
|
763 | /**
|
764 | * This structure is used in both `GetMetricData` and `PutMetricAlarm` . The supported use of this structure is different for those two operations.
|
765 | *
|
766 | * When used in `GetMetricData` , it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A single `GetMetricData` call can include up to 500 `MetricDataQuery` structures.
|
767 | *
|
768 | * When used in `PutMetricAlarm` , it enables you to create an alarm based on a metric math expression. Each `MetricDataQuery` in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single `PutMetricAlarm` call can include up to 20 `MetricDataQuery` structures in the array. The 20 structures can include as many as 10 structures that contain a `MetricStat` parameter to retrieve a metric, and as many as 10 structures that contain the `Expression` parameter to perform a math expression. Of those `Expression` structures, one must have `true` as the value for `ReturnData` . The result of this expression is the value the alarm watches.
|
769 | *
|
770 | * Any expression used in a `PutMetricAlarm` operation must return a single time series. For more information, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide* .
|
771 | *
|
772 | * Some of the parameters of this structure also have different uses whether you are using this structure in a `GetMetricData` operation or a `PutMetricAlarm` operation. These differences are explained in the following parameter list.
|
773 | *
|
774 | * @struct
|
775 | * @stability external
|
776 | *
|
777 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html
|
778 | */
|
779 | interface MetricDataQueryProperty {
|
780 | /**
|
781 | * The ID of the account where the metrics are located.
|
782 | *
|
783 | * If you are performing a `GetMetricData` operation in a monitoring account, use this to specify which account to retrieve this metric from.
|
784 | *
|
785 | * If you are performing a `PutMetricAlarm` operation, use this to specify which account contains the metric that the alarm is watching.
|
786 | *
|
787 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html#cfn-cloudwatch-anomalydetector-metricdataquery-accountid
|
788 | */
|
789 | readonly accountId?: string;
|
790 | /**
|
791 | * This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data. For more information about Metrics Insights queries, see [Metrics Insights query components and syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage) in the *Amazon CloudWatch User Guide* .
|
792 | *
|
793 | * A math expression can use the `Id` of the other metrics or queries to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide* .
|
794 | *
|
795 | * Within each MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both.
|
796 | *
|
797 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html#cfn-cloudwatch-anomalydetector-metricdataquery-expression
|
798 | */
|
799 | readonly expression?: string;
|
800 | /**
|
801 | * A short name used to tie this object to the results in the response. This name must be unique within a single call to `GetMetricData` . If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
|
802 | *
|
803 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html#cfn-cloudwatch-anomalydetector-metricdataquery-id
|
804 | */
|
805 | readonly id: string;
|
806 | /**
|
807 | * A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.
|
808 | *
|
809 | * You can put dynamic expressions into a label, so that it is more descriptive. For more information, see [Using Dynamic Labels](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html) .
|
810 | *
|
811 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html#cfn-cloudwatch-anomalydetector-metricdataquery-label
|
812 | */
|
813 | readonly label?: string;
|
814 | /**
|
815 | * The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
|
816 | *
|
817 | * Within one MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both.
|
818 | *
|
819 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html#cfn-cloudwatch-anomalydetector-metricdataquery-metricstat
|
820 | */
|
821 | readonly metricStat?: CfnAnomalyDetector.MetricStatProperty | cdk.IResolvable;
|
822 | /**
|
823 | * The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a `PutMetricData` operation that includes a `StorageResolution of 1 second` .
|
824 | *
|
825 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html#cfn-cloudwatch-anomalydetector-metricdataquery-period
|
826 | */
|
827 | readonly period?: number;
|
828 | /**
|
829 | * When used in `GetMetricData` , this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify `false` . If you omit this, the default of `true` is used.
|
830 | *
|
831 | * When used in `PutMetricAlarm` , specify `true` for the one expression result to use as the alarm. For all other metrics and expressions in the same `PutMetricAlarm` operation, specify `ReturnData` as False.
|
832 | *
|
833 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html#cfn-cloudwatch-anomalydetector-metricdataquery-returndata
|
834 | */
|
835 | readonly returnData?: boolean | cdk.IResolvable;
|
836 | }
|
837 | }
|
838 | export declare namespace CfnAnomalyDetector {
|
839 | /**
|
840 | * Indicates the CloudWatch math expression that provides the time series the anomaly detector uses as input. The designated math expression must return a single time series.
|
841 | *
|
842 | * @struct
|
843 | * @stability external
|
844 | *
|
845 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricmathanomalydetector.html
|
846 | */
|
847 | interface MetricMathAnomalyDetectorProperty {
|
848 | /**
|
849 | * An array of metric data query structures that enables you to create an anomaly detector based on the result of a metric math expression. Each item in `MetricDataQueries` gets a metric or performs a math expression. One item in `MetricDataQueries` is the expression that provides the time series that the anomaly detector uses as input. Designate the expression by setting `ReturnData` to `true` for this object in the array. For all other expressions and metrics, set `ReturnData` to `false` . The designated expression must return a single time series.
|
850 | *
|
851 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricmathanomalydetector.html#cfn-cloudwatch-anomalydetector-metricmathanomalydetector-metricdataqueries
|
852 | */
|
853 | readonly metricDataQueries?: Array<CfnAnomalyDetector.MetricDataQueryProperty | cdk.IResolvable> | cdk.IResolvable;
|
854 | }
|
855 | }
|
856 | export declare namespace CfnAnomalyDetector {
|
857 | /**
|
858 | * This structure defines the metric to be returned, along with the statistics, period, and units.
|
859 | *
|
860 | * @struct
|
861 | * @stability external
|
862 | *
|
863 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricstat.html
|
864 | */
|
865 | interface MetricStatProperty {
|
866 | /**
|
867 | * The metric to return, including the metric name, namespace, and dimensions.
|
868 | *
|
869 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricstat.html#cfn-cloudwatch-anomalydetector-metricstat-metric
|
870 | */
|
871 | readonly metric: CfnAnomalyDetector.MetricProperty | cdk.IResolvable;
|
872 | /**
|
873 | * The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a `PutMetricData` call that includes a `StorageResolution` of 1 second.
|
874 | *
|
875 | * If the `StartTime` parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
|
876 | *
|
877 | * - Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
|
878 | * - Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
|
879 | * - Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
|
880 | *
|
881 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricstat.html#cfn-cloudwatch-anomalydetector-metricstat-period
|
882 | */
|
883 | readonly period: number;
|
884 | /**
|
885 | * The statistic to return. It can include any CloudWatch statistic or extended statistic.
|
886 | *
|
887 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricstat.html#cfn-cloudwatch-anomalydetector-metricstat-stat
|
888 | */
|
889 | readonly stat: string;
|
890 | /**
|
891 | * When you are using a `Put` operation, this defines what unit you want to use when storing the metric.
|
892 | *
|
893 | * In a `Get` operation, if you omit `Unit` then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.
|
894 | *
|
895 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricstat.html#cfn-cloudwatch-anomalydetector-metricstat-unit
|
896 | */
|
897 | readonly unit?: string;
|
898 | }
|
899 | }
|
900 | export declare namespace CfnAnomalyDetector {
|
901 | /**
|
902 | * Each `Range` specifies one range of days or times to exclude from use for training or updating an anomaly detection model.
|
903 | *
|
904 | * @struct
|
905 | * @stability external
|
906 | *
|
907 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-range.html
|
908 | */
|
909 | interface RangeProperty {
|
910 | /**
|
911 | * The end time of the range to exclude. The format is `yyyy-MM-dd'T'HH:mm:ss` . For example, `2019-07-01T23:59:59` .
|
912 | *
|
913 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-range.html#cfn-cloudwatch-anomalydetector-range-endtime
|
914 | */
|
915 | readonly endTime: string;
|
916 | /**
|
917 | * The start time of the range to exclude. The format is `yyyy-MM-dd'T'HH:mm:ss` . For example, `2019-07-01T23:59:59` .
|
918 | *
|
919 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-range.html#cfn-cloudwatch-anomalydetector-range-starttime
|
920 | */
|
921 | readonly startTime: string;
|
922 | }
|
923 | }
|
924 | export declare namespace CfnAnomalyDetector {
|
925 | /**
|
926 | * Designates the CloudWatch metric and statistic that provides the time series the anomaly detector uses as input.
|
927 | *
|
928 | * @struct
|
929 | * @stability external
|
930 | *
|
931 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-singlemetricanomalydetector.html
|
932 | */
|
933 | interface SingleMetricAnomalyDetectorProperty {
|
934 | /**
|
935 | * The metric dimensions to create the anomaly detection model for.
|
936 | *
|
937 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-singlemetricanomalydetector.html#cfn-cloudwatch-anomalydetector-singlemetricanomalydetector-dimensions
|
938 | */
|
939 | readonly dimensions?: Array<CfnAnomalyDetector.DimensionProperty | cdk.IResolvable> | cdk.IResolvable;
|
940 | /**
|
941 | * The name of the metric to create the anomaly detection model for.
|
942 | *
|
943 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-singlemetricanomalydetector.html#cfn-cloudwatch-anomalydetector-singlemetricanomalydetector-metricname
|
944 | */
|
945 | readonly metricName?: string;
|
946 | /**
|
947 | * The namespace of the metric to create the anomaly detection model for.
|
948 | *
|
949 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-singlemetricanomalydetector.html#cfn-cloudwatch-anomalydetector-singlemetricanomalydetector-namespace
|
950 | */
|
951 | readonly namespace?: string;
|
952 | /**
|
953 | * The statistic to use for the metric and anomaly detection model.
|
954 | *
|
955 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-singlemetricanomalydetector.html#cfn-cloudwatch-anomalydetector-singlemetricanomalydetector-stat
|
956 | */
|
957 | readonly stat?: string;
|
958 | }
|
959 | }
|
960 | /**
|
961 | * Properties for defining a `CfnCompositeAlarm`
|
962 | *
|
963 | * @struct
|
964 | * @stability external
|
965 | *
|
966 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html
|
967 | */
|
968 | export interface CfnCompositeAlarmProps {
|
969 | /**
|
970 | * An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state. For each alarm that you reference, you designate a function that specifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You can use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the functions in your expression.
|
971 | *
|
972 | * You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.
|
973 | *
|
974 | * Functions can include the following:
|
975 | *
|
976 | * - ALARM("alarm-name or alarm-ARN") is TRUE if the named alarm is in ALARM state.
|
977 | * - OK("alarm-name or alarm-ARN") is TRUE if the named alarm is in OK state.
|
978 | * - INSUFFICIENT_DATA("alarm-name or alarm-ARN") is TRUE if the named alarm is in INSUFFICIENT_DATA state.
|
979 | * - TRUE always evaluates to TRUE.
|
980 | * - FALSE always evaluates to FALSE.
|
981 | *
|
982 | * TRUE and FALSE are useful for testing a complex AlarmRule structure, and for testing your alarm actions.
|
983 | *
|
984 | * For more information about `AlarmRule` syntax, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the *Amazon CloudWatch API Reference* .
|
985 | *
|
986 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmrule
|
987 | */
|
988 | readonly alarmRule: string;
|
989 | /**
|
990 | * Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is TRUE.
|
991 | *
|
992 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionsenabled
|
993 | */
|
994 | readonly actionsEnabled?: boolean | cdk.IResolvable;
|
995 | /**
|
996 | * Actions will be suppressed if the suppressor alarm is in the `ALARM` state. `ActionsSuppressor` can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.
|
997 | *
|
998 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionssuppressor
|
999 | */
|
1000 | readonly actionsSuppressor?: string;
|
1001 | /**
|
1002 | * The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the `ALARM` state. After this time, the composite alarm performs its actions.
|
1003 | *
|
1004 | * > `ExtensionPeriod` is required only when `ActionsSuppressor` is specified.
|
1005 | *
|
1006 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionssuppressorextensionperiod
|
1007 | */
|
1008 | readonly actionsSuppressorExtensionPeriod?: number;
|
1009 | /**
|
1010 | * The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the `ALARM` state. After this time, the composite alarm performs its actions.
|
1011 | *
|
1012 | * > `WaitPeriod` is required only when `ActionsSuppressor` is specified.
|
1013 | *
|
1014 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionssuppressorwaitperiod
|
1015 | */
|
1016 | readonly actionsSuppressorWaitPeriod?: number;
|
1017 | /**
|
1018 | * The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the *Amazon CloudWatch API Reference* .
|
1019 | *
|
1020 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmactions
|
1021 | */
|
1022 | readonly alarmActions?: string[];
|
1023 | /**
|
1024 | * The description for the composite alarm.
|
1025 | *
|
1026 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmdescription
|
1027 | */
|
1028 | readonly alarmDescription?: string;
|
1029 | /**
|
1030 | * The name for the composite alarm. This name must be unique within your AWS account.
|
1031 | *
|
1032 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmname
|
1033 | */
|
1034 | readonly alarmName?: string;
|
1035 | /**
|
1036 | * The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the *Amazon CloudWatch API Reference* .
|
1037 | *
|
1038 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-insufficientdataactions
|
1039 | */
|
1040 | readonly insufficientDataActions?: string[];
|
1041 | /**
|
1042 | * The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the *Amazon CloudWatch API Reference* .
|
1043 | *
|
1044 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-okactions
|
1045 | */
|
1046 | readonly okActions?: string[];
|
1047 | }
|
1048 | /**
|
1049 | * A CloudFormation `AWS::CloudWatch::CompositeAlarm`
|
1050 | *
|
1051 | * The `AWS::CloudWatch::CompositeAlarm` type creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.
|
1052 | *
|
1053 | * The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.
|
1054 | *
|
1055 | * Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.
|
1056 | *
|
1057 | * Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.
|
1058 | *
|
1059 | * When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.
|
1060 | *
|
1061 | * When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
|
1062 | *
|
1063 | * @cloudformationResource AWS::CloudWatch::CompositeAlarm
|
1064 | * @stability external
|
1065 | *
|
1066 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html
|
1067 | */
|
1068 | export declare class CfnCompositeAlarm extends cdk.CfnResource implements cdk.IInspectable {
|
1069 | /**
|
1070 | * The CloudFormation resource type name for this resource class.
|
1071 | */
|
1072 | static readonly CFN_RESOURCE_TYPE_NAME = "AWS::CloudWatch::CompositeAlarm";
|
1073 | /**
|
1074 | * A factory method that creates a new instance of this class from an object
|
1075 | * containing the CloudFormation properties of this resource.
|
1076 | * Used in the @aws-cdk/cloudformation-include module.
|
1077 | *
|
1078 | * @internal
|
1079 | */
|
1080 | static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnCompositeAlarm;
|
1081 | /**
|
1082 | * The ARN of the composite alarm, such as `arn:aws:cloudwatch:us-west-2:123456789012:alarm/CompositeAlarmName` .
|
1083 | * @cloudformationAttribute Arn
|
1084 | */
|
1085 | readonly attrArn: string;
|
1086 | /**
|
1087 | * An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state. For each alarm that you reference, you designate a function that specifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You can use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the functions in your expression.
|
1088 | *
|
1089 | * You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.
|
1090 | *
|
1091 | * Functions can include the following:
|
1092 | *
|
1093 | * - ALARM("alarm-name or alarm-ARN") is TRUE if the named alarm is in ALARM state.
|
1094 | * - OK("alarm-name or alarm-ARN") is TRUE if the named alarm is in OK state.
|
1095 | * - INSUFFICIENT_DATA("alarm-name or alarm-ARN") is TRUE if the named alarm is in INSUFFICIENT_DATA state.
|
1096 | * - TRUE always evaluates to TRUE.
|
1097 | * - FALSE always evaluates to FALSE.
|
1098 | *
|
1099 | * TRUE and FALSE are useful for testing a complex AlarmRule structure, and for testing your alarm actions.
|
1100 | *
|
1101 | * For more information about `AlarmRule` syntax, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the *Amazon CloudWatch API Reference* .
|
1102 | *
|
1103 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmrule
|
1104 | */
|
1105 | alarmRule: string;
|
1106 | /**
|
1107 | * Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is TRUE.
|
1108 | *
|
1109 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionsenabled
|
1110 | */
|
1111 | actionsEnabled: boolean | cdk.IResolvable | undefined;
|
1112 | /**
|
1113 | * Actions will be suppressed if the suppressor alarm is in the `ALARM` state. `ActionsSuppressor` can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.
|
1114 | *
|
1115 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionssuppressor
|
1116 | */
|
1117 | actionsSuppressor: string | undefined;
|
1118 | /**
|
1119 | * The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the `ALARM` state. After this time, the composite alarm performs its actions.
|
1120 | *
|
1121 | * > `ExtensionPeriod` is required only when `ActionsSuppressor` is specified.
|
1122 | *
|
1123 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionssuppressorextensionperiod
|
1124 | */
|
1125 | actionsSuppressorExtensionPeriod: number | undefined;
|
1126 | /**
|
1127 | * The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the `ALARM` state. After this time, the composite alarm performs its actions.
|
1128 | *
|
1129 | * > `WaitPeriod` is required only when `ActionsSuppressor` is specified.
|
1130 | *
|
1131 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionssuppressorwaitperiod
|
1132 | */
|
1133 | actionsSuppressorWaitPeriod: number | undefined;
|
1134 | /**
|
1135 | * The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the *Amazon CloudWatch API Reference* .
|
1136 | *
|
1137 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmactions
|
1138 | */
|
1139 | alarmActions: string[] | undefined;
|
1140 | /**
|
1141 | * The description for the composite alarm.
|
1142 | *
|
1143 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmdescription
|
1144 | */
|
1145 | alarmDescription: string | undefined;
|
1146 | /**
|
1147 | * The name for the composite alarm. This name must be unique within your AWS account.
|
1148 | *
|
1149 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmname
|
1150 | */
|
1151 | alarmName: string | undefined;
|
1152 | /**
|
1153 | * The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the *Amazon CloudWatch API Reference* .
|
1154 | *
|
1155 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-insufficientdataactions
|
1156 | */
|
1157 | insufficientDataActions: string[] | undefined;
|
1158 | /**
|
1159 | * The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the *Amazon CloudWatch API Reference* .
|
1160 | *
|
1161 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-okactions
|
1162 | */
|
1163 | okActions: string[] | undefined;
|
1164 | /**
|
1165 | * Create a new `AWS::CloudWatch::CompositeAlarm`.
|
1166 | *
|
1167 | * @param scope - scope in which this resource is defined
|
1168 | * @param id - scoped id of the resource
|
1169 | * @param props - resource properties
|
1170 | */
|
1171 | constructor(scope: cdk.Construct, id: string, props: CfnCompositeAlarmProps);
|
1172 | /**
|
1173 | * Examines the CloudFormation resource and discloses attributes.
|
1174 | *
|
1175 | * @param inspector - tree inspector to collect and process attributes
|
1176 | *
|
1177 | */
|
1178 | inspect(inspector: cdk.TreeInspector): void;
|
1179 | protected get cfnProperties(): {
|
1180 | [key: string]: any;
|
1181 | };
|
1182 | protected renderProperties(props: {
|
1183 | [key: string]: any;
|
1184 | }): {
|
1185 | [key: string]: any;
|
1186 | };
|
1187 | }
|
1188 | /**
|
1189 | * Properties for defining a `CfnDashboard`
|
1190 | *
|
1191 | * @struct
|
1192 | * @stability external
|
1193 | *
|
1194 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html
|
1195 | */
|
1196 | export interface CfnDashboardProps {
|
1197 | /**
|
1198 | * The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required.
|
1199 | *
|
1200 | * For more information about the syntax, see [Dashboard Body Structure and Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html) .
|
1201 | *
|
1202 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html#cfn-cloudwatch-dashboard-dashboardbody
|
1203 | */
|
1204 | readonly dashboardBody: string;
|
1205 | /**
|
1206 | * The name of the dashboard. The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically.
|
1207 | *
|
1208 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html#cfn-cloudwatch-dashboard-dashboardname
|
1209 | */
|
1210 | readonly dashboardName?: string;
|
1211 | }
|
1212 | /**
|
1213 | * A CloudFormation `AWS::CloudWatch::Dashboard`
|
1214 | *
|
1215 | * The `AWS::CloudWatch::Dashboard` resource specifies an Amazon CloudWatch dashboard. A dashboard is a customizable home page in the CloudWatch console that you can use to monitor your AWS resources in a single view.
|
1216 | *
|
1217 | * All dashboards in your account are global, not region-specific.
|
1218 | *
|
1219 | * @cloudformationResource AWS::CloudWatch::Dashboard
|
1220 | * @stability external
|
1221 | *
|
1222 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html
|
1223 | */
|
1224 | export declare class CfnDashboard extends cdk.CfnResource implements cdk.IInspectable {
|
1225 | /**
|
1226 | * The CloudFormation resource type name for this resource class.
|
1227 | */
|
1228 | static readonly CFN_RESOURCE_TYPE_NAME = "AWS::CloudWatch::Dashboard";
|
1229 | /**
|
1230 | * A factory method that creates a new instance of this class from an object
|
1231 | * containing the CloudFormation properties of this resource.
|
1232 | * Used in the @aws-cdk/cloudformation-include module.
|
1233 | *
|
1234 | * @internal
|
1235 | */
|
1236 | static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDashboard;
|
1237 | /**
|
1238 | * The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required.
|
1239 | *
|
1240 | * For more information about the syntax, see [Dashboard Body Structure and Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html) .
|
1241 | *
|
1242 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html#cfn-cloudwatch-dashboard-dashboardbody
|
1243 | */
|
1244 | dashboardBody: string;
|
1245 | /**
|
1246 | * The name of the dashboard. The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically.
|
1247 | *
|
1248 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html#cfn-cloudwatch-dashboard-dashboardname
|
1249 | */
|
1250 | dashboardName: string | undefined;
|
1251 | /**
|
1252 | * Create a new `AWS::CloudWatch::Dashboard`.
|
1253 | *
|
1254 | * @param scope - scope in which this resource is defined
|
1255 | * @param id - scoped id of the resource
|
1256 | * @param props - resource properties
|
1257 | */
|
1258 | constructor(scope: cdk.Construct, id: string, props: CfnDashboardProps);
|
1259 | /**
|
1260 | * Examines the CloudFormation resource and discloses attributes.
|
1261 | *
|
1262 | * @param inspector - tree inspector to collect and process attributes
|
1263 | *
|
1264 | */
|
1265 | inspect(inspector: cdk.TreeInspector): void;
|
1266 | protected get cfnProperties(): {
|
1267 | [key: string]: any;
|
1268 | };
|
1269 | protected renderProperties(props: {
|
1270 | [key: string]: any;
|
1271 | }): {
|
1272 | [key: string]: any;
|
1273 | };
|
1274 | }
|
1275 | /**
|
1276 | * Properties for defining a `CfnInsightRule`
|
1277 | *
|
1278 | * @struct
|
1279 | * @stability external
|
1280 | *
|
1281 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html
|
1282 | */
|
1283 | export interface CfnInsightRuleProps {
|
1284 | /**
|
1285 | * The definition of the rule, as a JSON object. For details about the syntax, see [Contributor Insights Rule Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html) in the *Amazon CloudWatch User Guide* .
|
1286 | *
|
1287 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulebody
|
1288 | */
|
1289 | readonly ruleBody: string;
|
1290 | /**
|
1291 | * The name of the rule.
|
1292 | *
|
1293 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulename
|
1294 | */
|
1295 | readonly ruleName: string;
|
1296 | /**
|
1297 | * The current state of the rule. Valid values are `ENABLED` and `DISABLED` .
|
1298 | *
|
1299 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulestate
|
1300 | */
|
1301 | readonly ruleState: string;
|
1302 | /**
|
1303 | * A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.
|
1304 | *
|
1305 | * Tags can help you organize and categorize your resources. For more information, see [Tagging Your Amazon CloudWatch Resources](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Tagging.html) .
|
1306 | *
|
1307 | * To be able to associate tags with a rule, you must have the `cloudwatch:TagResource` permission in addition to the `cloudwatch:PutInsightRule` permission.
|
1308 | *
|
1309 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-tags
|
1310 | */
|
1311 | readonly tags?: Array<cdk.CfnTag | cdk.IResolvable> | cdk.IResolvable;
|
1312 | }
|
1313 | /**
|
1314 | * A CloudFormation `AWS::CloudWatch::InsightRule`
|
1315 | *
|
1316 | * Creates or updates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see [Using Contributor Insights to Analyze High-Cardinality Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html) in the *Amazon CloudWatch User Guide* .
|
1317 | *
|
1318 | * @cloudformationResource AWS::CloudWatch::InsightRule
|
1319 | * @stability external
|
1320 | *
|
1321 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html
|
1322 | */
|
1323 | export declare class CfnInsightRule extends cdk.CfnResource implements cdk.IInspectable {
|
1324 | /**
|
1325 | * The CloudFormation resource type name for this resource class.
|
1326 | */
|
1327 | static readonly CFN_RESOURCE_TYPE_NAME = "AWS::CloudWatch::InsightRule";
|
1328 | /**
|
1329 | * A factory method that creates a new instance of this class from an object
|
1330 | * containing the CloudFormation properties of this resource.
|
1331 | * Used in the @aws-cdk/cloudformation-include module.
|
1332 | *
|
1333 | * @internal
|
1334 | */
|
1335 | static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnInsightRule;
|
1336 | /**
|
1337 | * The ARN of the Contributor Insights rule, such as `arn:aws:cloudwatch:us-west-2:123456789012:insight-rule/MyInsightRuleName` .
|
1338 | * @cloudformationAttribute Arn
|
1339 | */
|
1340 | readonly attrArn: string;
|
1341 | /**
|
1342 | * The name of the Contributor Insights rule.
|
1343 | * @cloudformationAttribute RuleName
|
1344 | */
|
1345 | readonly attrRuleName: string;
|
1346 | /**
|
1347 | * The definition of the rule, as a JSON object. For details about the syntax, see [Contributor Insights Rule Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html) in the *Amazon CloudWatch User Guide* .
|
1348 | *
|
1349 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulebody
|
1350 | */
|
1351 | ruleBody: string;
|
1352 | /**
|
1353 | * The name of the rule.
|
1354 | *
|
1355 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulename
|
1356 | */
|
1357 | ruleName: string;
|
1358 | /**
|
1359 | * The current state of the rule. Valid values are `ENABLED` and `DISABLED` .
|
1360 | *
|
1361 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulestate
|
1362 | */
|
1363 | ruleState: string;
|
1364 | /**
|
1365 | * A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.
|
1366 | *
|
1367 | * Tags can help you organize and categorize your resources. For more information, see [Tagging Your Amazon CloudWatch Resources](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Tagging.html) .
|
1368 | *
|
1369 | * To be able to associate tags with a rule, you must have the `cloudwatch:TagResource` permission in addition to the `cloudwatch:PutInsightRule` permission.
|
1370 | *
|
1371 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-tags
|
1372 | */
|
1373 | readonly tags: cdk.TagManager;
|
1374 | /**
|
1375 | * Create a new `AWS::CloudWatch::InsightRule`.
|
1376 | *
|
1377 | * @param scope - scope in which this resource is defined
|
1378 | * @param id - scoped id of the resource
|
1379 | * @param props - resource properties
|
1380 | */
|
1381 | constructor(scope: cdk.Construct, id: string, props: CfnInsightRuleProps);
|
1382 | /**
|
1383 | * Examines the CloudFormation resource and discloses attributes.
|
1384 | *
|
1385 | * @param inspector - tree inspector to collect and process attributes
|
1386 | *
|
1387 | */
|
1388 | inspect(inspector: cdk.TreeInspector): void;
|
1389 | protected get cfnProperties(): {
|
1390 | [key: string]: any;
|
1391 | };
|
1392 | protected renderProperties(props: {
|
1393 | [key: string]: any;
|
1394 | }): {
|
1395 | [key: string]: any;
|
1396 | };
|
1397 | }
|
1398 | /**
|
1399 | * Properties for defining a `CfnMetricStream`
|
1400 | *
|
1401 | * @struct
|
1402 | * @stability external
|
1403 | *
|
1404 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html
|
1405 | */
|
1406 | export interface CfnMetricStreamProps {
|
1407 | /**
|
1408 | * The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream. This Amazon Kinesis Firehose delivery stream must already exist and must be in the same account as the metric stream.
|
1409 | *
|
1410 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-firehosearn
|
1411 | */
|
1412 | readonly firehoseArn: string;
|
1413 | /**
|
1414 | * The output format for the stream. Valid values are `json` and `opentelemetry0.7` For more information about metric stream output formats, see [Metric streams output formats](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html) .
|
1415 | *
|
1416 | * This parameter is required.
|
1417 | *
|
1418 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-outputformat
|
1419 | */
|
1420 | readonly outputFormat: string;
|
1421 | /**
|
1422 | * The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources. This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include the `firehose:PutRecord` and `firehose:PutRecordBatch` permissions.
|
1423 | *
|
1424 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-rolearn
|
1425 | */
|
1426 | readonly roleArn: string;
|
1427 | /**
|
1428 | * If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here. You cannot specify both `IncludeFilters` and `ExcludeFilters` in the same metric stream.
|
1429 | *
|
1430 | * When you modify the `IncludeFilters` or `ExcludeFilters` of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update.
|
1431 | *
|
1432 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-excludefilters
|
1433 | */
|
1434 | readonly excludeFilters?: Array<CfnMetricStream.MetricStreamFilterProperty | cdk.IResolvable> | cdk.IResolvable;
|
1435 | /**
|
1436 | * If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here. You cannot specify both `IncludeFilters` and `ExcludeFilters` in the same metric stream.
|
1437 | *
|
1438 | * When you modify the `IncludeFilters` or `ExcludeFilters` of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update.
|
1439 | *
|
1440 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-includefilters
|
1441 | */
|
1442 | readonly includeFilters?: Array<CfnMetricStream.MetricStreamFilterProperty | cdk.IResolvable> | cdk.IResolvable;
|
1443 | /**
|
1444 | * If you are creating a metric stream in a monitoring account, specify `true` to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default is `false` .
|
1445 | *
|
1446 | * For more information about linking accounts, see [CloudWatch cross-account observability](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html)
|
1447 | *
|
1448 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-includelinkedaccountsmetrics
|
1449 | */
|
1450 | readonly includeLinkedAccountsMetrics?: boolean | cdk.IResolvable;
|
1451 | /**
|
1452 | * If you are creating a new metric stream, this is the name for the new stream. The name must be different than the names of other metric streams in this account and Region.
|
1453 | *
|
1454 | * If you are updating a metric stream, specify the name of that stream here.
|
1455 | *
|
1456 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-name
|
1457 | */
|
1458 | readonly name?: string;
|
1459 | /**
|
1460 | * By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.
|
1461 | *
|
1462 | * For each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics. The additional statistics that you can stream depend on the stream's `OutputFormat` . If the `OutputFormat` is `json` , you can stream any additional statistic that is supported by CloudWatch , listed in [CloudWatch statistics definitions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html) . If the `OutputFormat` is `opentelemetry0` .7, you can stream percentile statistics *(p??)* .
|
1463 | *
|
1464 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-statisticsconfigurations
|
1465 | */
|
1466 | readonly statisticsConfigurations?: Array<CfnMetricStream.MetricStreamStatisticsConfigurationProperty | cdk.IResolvable> | cdk.IResolvable;
|
1467 | /**
|
1468 | * An array of key-value pairs to apply to the metric stream.
|
1469 | *
|
1470 | * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
|
1471 | *
|
1472 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-tags
|
1473 | */
|
1474 | readonly tags?: cdk.CfnTag[];
|
1475 | }
|
1476 | /**
|
1477 | * A CloudFormation `AWS::CloudWatch::MetricStream`
|
1478 | *
|
1479 | * Creates or updates a metric stream. Metrics streams can automatically stream CloudWatch metrics to AWS destinations including Amazon S3 and to many third-party solutions. For more information, see [Metric streams](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html) .
|
1480 | *
|
1481 | * To create a metric stream, you must be logged on to an account that has the `iam:PassRole` permission and either the *CloudWatchFullAccess* policy or the `cloudwatch:PutMetricStream` permission.
|
1482 | *
|
1483 | * When you create or update a metric stream, you choose one of the following:
|
1484 | *
|
1485 | * - Stream metrics from all metric namespaces in the account.
|
1486 | * - Stream metrics from all metric namespaces in the account, except for the namespaces that you list in `ExcludeFilters` .
|
1487 | * - Stream metrics from only the metric namespaces that you list in `IncludeFilters` .
|
1488 | *
|
1489 | * When you create a metric stream, the stream is created in the `running` state. If you update an existing metric stream, the state does not change.
|
1490 | *
|
1491 | * If you create a metric stream in an account that has been set up as a monitoring account in CloudWatch cross-account observability, you can choose whether to include metrics from linked source accounts in the metric stream.
|
1492 | *
|
1493 | * @cloudformationResource AWS::CloudWatch::MetricStream
|
1494 | * @stability external
|
1495 | *
|
1496 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html
|
1497 | */
|
1498 | export declare class CfnMetricStream extends cdk.CfnResource implements cdk.IInspectable {
|
1499 | /**
|
1500 | * The CloudFormation resource type name for this resource class.
|
1501 | */
|
1502 | static readonly CFN_RESOURCE_TYPE_NAME = "AWS::CloudWatch::MetricStream";
|
1503 | /**
|
1504 | * A factory method that creates a new instance of this class from an object
|
1505 | * containing the CloudFormation properties of this resource.
|
1506 | * Used in the @aws-cdk/cloudformation-include module.
|
1507 | *
|
1508 | * @internal
|
1509 | */
|
1510 | static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnMetricStream;
|
1511 | /**
|
1512 | * The ARN of the metric stream.
|
1513 | * @cloudformationAttribute Arn
|
1514 | */
|
1515 | readonly attrArn: string;
|
1516 | /**
|
1517 | * The date that the metric stream was originally created.
|
1518 | * @cloudformationAttribute CreationDate
|
1519 | */
|
1520 | readonly attrCreationDate: string;
|
1521 | /**
|
1522 | * The date that the metric stream was most recently updated.
|
1523 | * @cloudformationAttribute LastUpdateDate
|
1524 | */
|
1525 | readonly attrLastUpdateDate: string;
|
1526 | /**
|
1527 | * The state of the metric stream, either `running` or `stopped` .
|
1528 | * @cloudformationAttribute State
|
1529 | */
|
1530 | readonly attrState: string;
|
1531 | /**
|
1532 | * The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream. This Amazon Kinesis Firehose delivery stream must already exist and must be in the same account as the metric stream.
|
1533 | *
|
1534 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-firehosearn
|
1535 | */
|
1536 | firehoseArn: string;
|
1537 | /**
|
1538 | * The output format for the stream. Valid values are `json` and `opentelemetry0.7` For more information about metric stream output formats, see [Metric streams output formats](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html) .
|
1539 | *
|
1540 | * This parameter is required.
|
1541 | *
|
1542 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-outputformat
|
1543 | */
|
1544 | outputFormat: string;
|
1545 | /**
|
1546 | * The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources. This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include the `firehose:PutRecord` and `firehose:PutRecordBatch` permissions.
|
1547 | *
|
1548 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-rolearn
|
1549 | */
|
1550 | roleArn: string;
|
1551 | /**
|
1552 | * If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here. You cannot specify both `IncludeFilters` and `ExcludeFilters` in the same metric stream.
|
1553 | *
|
1554 | * When you modify the `IncludeFilters` or `ExcludeFilters` of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update.
|
1555 | *
|
1556 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-excludefilters
|
1557 | */
|
1558 | excludeFilters: Array<CfnMetricStream.MetricStreamFilterProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
|
1559 | /**
|
1560 | * If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here. You cannot specify both `IncludeFilters` and `ExcludeFilters` in the same metric stream.
|
1561 | *
|
1562 | * When you modify the `IncludeFilters` or `ExcludeFilters` of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update.
|
1563 | *
|
1564 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-includefilters
|
1565 | */
|
1566 | includeFilters: Array<CfnMetricStream.MetricStreamFilterProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
|
1567 | /**
|
1568 | * If you are creating a metric stream in a monitoring account, specify `true` to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default is `false` .
|
1569 | *
|
1570 | * For more information about linking accounts, see [CloudWatch cross-account observability](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html)
|
1571 | *
|
1572 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-includelinkedaccountsmetrics
|
1573 | */
|
1574 | includeLinkedAccountsMetrics: boolean | cdk.IResolvable | undefined;
|
1575 | /**
|
1576 | * If you are creating a new metric stream, this is the name for the new stream. The name must be different than the names of other metric streams in this account and Region.
|
1577 | *
|
1578 | * If you are updating a metric stream, specify the name of that stream here.
|
1579 | *
|
1580 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-name
|
1581 | */
|
1582 | name: string | undefined;
|
1583 | /**
|
1584 | * By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.
|
1585 | *
|
1586 | * For each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics. The additional statistics that you can stream depend on the stream's `OutputFormat` . If the `OutputFormat` is `json` , you can stream any additional statistic that is supported by CloudWatch , listed in [CloudWatch statistics definitions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html) . If the `OutputFormat` is `opentelemetry0` .7, you can stream percentile statistics *(p??)* .
|
1587 | *
|
1588 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-statisticsconfigurations
|
1589 | */
|
1590 | statisticsConfigurations: Array<CfnMetricStream.MetricStreamStatisticsConfigurationProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
|
1591 | /**
|
1592 | * An array of key-value pairs to apply to the metric stream.
|
1593 | *
|
1594 | * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
|
1595 | *
|
1596 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-tags
|
1597 | */
|
1598 | readonly tags: cdk.TagManager;
|
1599 | /**
|
1600 | * Create a new `AWS::CloudWatch::MetricStream`.
|
1601 | *
|
1602 | * @param scope - scope in which this resource is defined
|
1603 | * @param id - scoped id of the resource
|
1604 | * @param props - resource properties
|
1605 | */
|
1606 | constructor(scope: cdk.Construct, id: string, props: CfnMetricStreamProps);
|
1607 | /**
|
1608 | * Examines the CloudFormation resource and discloses attributes.
|
1609 | *
|
1610 | * @param inspector - tree inspector to collect and process attributes
|
1611 | *
|
1612 | */
|
1613 | inspect(inspector: cdk.TreeInspector): void;
|
1614 | protected get cfnProperties(): {
|
1615 | [key: string]: any;
|
1616 | };
|
1617 | protected renderProperties(props: {
|
1618 | [key: string]: any;
|
1619 | }): {
|
1620 | [key: string]: any;
|
1621 | };
|
1622 | }
|
1623 | export declare namespace CfnMetricStream {
|
1624 | /**
|
1625 | * This structure contains the name of one of the metric namespaces that is listed in a filter of a metric stream.
|
1626 | *
|
1627 | * @struct
|
1628 | * @stability external
|
1629 | *
|
1630 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamfilter.html
|
1631 | */
|
1632 | interface MetricStreamFilterProperty {
|
1633 | /**
|
1634 | * The name of the metric namespace in the filter.
|
1635 | *
|
1636 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamfilter.html#cfn-cloudwatch-metricstream-metricstreamfilter-namespace
|
1637 | */
|
1638 | readonly namespace: string;
|
1639 | }
|
1640 | }
|
1641 | export declare namespace CfnMetricStream {
|
1642 | /**
|
1643 | * This structure specifies a list of additional statistics to stream, and the metrics to stream those additional statistics for.
|
1644 | *
|
1645 | * All metrics that match the combination of metric name and namespace will be streamed with the additional statistics, no matter their dimensions.
|
1646 | *
|
1647 | * @struct
|
1648 | * @stability external
|
1649 | *
|
1650 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsconfiguration.html
|
1651 | */
|
1652 | interface MetricStreamStatisticsConfigurationProperty {
|
1653 | /**
|
1654 | * The additional statistics to stream for the metrics listed in `IncludeMetrics` .
|
1655 | *
|
1656 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsconfiguration.html#cfn-cloudwatch-metricstream-metricstreamstatisticsconfiguration-additionalstatistics
|
1657 | */
|
1658 | readonly additionalStatistics: string[];
|
1659 | /**
|
1660 | * An array that defines the metrics that are to have additional statistics streamed.
|
1661 | *
|
1662 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsconfiguration.html#cfn-cloudwatch-metricstream-metricstreamstatisticsconfiguration-includemetrics
|
1663 | */
|
1664 | readonly includeMetrics: Array<CfnMetricStream.MetricStreamStatisticsMetricProperty | cdk.IResolvable> | cdk.IResolvable;
|
1665 | }
|
1666 | }
|
1667 | export declare namespace CfnMetricStream {
|
1668 | /**
|
1669 | * A structure that specifies the metric name and namespace for one metric that is going to have additional statistics included in the stream.
|
1670 | *
|
1671 | * @struct
|
1672 | * @stability external
|
1673 | *
|
1674 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsmetric.html
|
1675 | */
|
1676 | interface MetricStreamStatisticsMetricProperty {
|
1677 | /**
|
1678 | * The name of the metric.
|
1679 | *
|
1680 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsmetric.html#cfn-cloudwatch-metricstream-metricstreamstatisticsmetric-metricname
|
1681 | */
|
1682 | readonly metricName: string;
|
1683 | /**
|
1684 | * The namespace of the metric.
|
1685 | *
|
1686 | * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsmetric.html#cfn-cloudwatch-metricstream-metricstreamstatisticsmetric-namespace
|
1687 | */
|
1688 | readonly namespace: string;
|
1689 | }
|
1690 | }
|