UNPKG

474 kBPlain TextView Raw
1{
2 "author": {
3 "name": "Amazon Web Services",
4 "organization": true,
5 "roles": [
6 "author"
7 ],
8 "url": "https://aws.amazon.com"
9 },
10 "dependencies": {
11 "@aws-cdk/aws-iam": "1.161.0",
12 "@aws-cdk/core": "1.161.0",
13 "constructs": "^3.3.69"
14 },
15 "dependencyClosure": {
16 "@aws-cdk/aws-iam": {
17 "targets": {
18 "dotnet": {
19 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
20 "namespace": "Amazon.CDK.AWS.IAM",
21 "packageId": "Amazon.CDK.AWS.IAM"
22 },
23 "java": {
24 "maven": {
25 "artifactId": "iam",
26 "groupId": "software.amazon.awscdk"
27 },
28 "package": "software.amazon.awscdk.services.iam"
29 },
30 "js": {
31 "npm": "@aws-cdk/aws-iam"
32 },
33 "python": {
34 "classifiers": [
35 "Framework :: AWS CDK",
36 "Framework :: AWS CDK :: 1"
37 ],
38 "distName": "aws-cdk.aws-iam",
39 "module": "aws_cdk.aws_iam"
40 }
41 }
42 },
43 "@aws-cdk/cloud-assembly-schema": {
44 "targets": {
45 "dotnet": {
46 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
47 "namespace": "Amazon.CDK.CloudAssembly.Schema",
48 "packageId": "Amazon.CDK.CloudAssembly.Schema"
49 },
50 "java": {
51 "maven": {
52 "artifactId": "cdk-cloud-assembly-schema",
53 "groupId": "software.amazon.awscdk"
54 },
55 "package": "software.amazon.awscdk.cloudassembly.schema"
56 },
57 "js": {
58 "npm": "@aws-cdk/cloud-assembly-schema"
59 },
60 "python": {
61 "classifiers": [
62 "Framework :: AWS CDK",
63 "Framework :: AWS CDK :: 1"
64 ],
65 "distName": "aws-cdk.cloud-assembly-schema",
66 "module": "aws_cdk.cloud_assembly_schema"
67 }
68 }
69 },
70 "@aws-cdk/core": {
71 "targets": {
72 "dotnet": {
73 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
74 "namespace": "Amazon.CDK",
75 "packageId": "Amazon.CDK"
76 },
77 "java": {
78 "maven": {
79 "artifactId": "core",
80 "groupId": "software.amazon.awscdk"
81 },
82 "package": "software.amazon.awscdk.core"
83 },
84 "js": {
85 "npm": "@aws-cdk/core"
86 },
87 "python": {
88 "classifiers": [
89 "Framework :: AWS CDK",
90 "Framework :: AWS CDK :: 1"
91 ],
92 "distName": "aws-cdk.core",
93 "module": "aws_cdk.core"
94 }
95 }
96 },
97 "@aws-cdk/cx-api": {
98 "targets": {
99 "dotnet": {
100 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
101 "namespace": "Amazon.CDK.CXAPI",
102 "packageId": "Amazon.CDK.CXAPI"
103 },
104 "java": {
105 "maven": {
106 "artifactId": "cdk-cx-api",
107 "groupId": "software.amazon.awscdk"
108 },
109 "package": "software.amazon.awscdk.cxapi"
110 },
111 "js": {
112 "npm": "@aws-cdk/cx-api"
113 },
114 "python": {
115 "classifiers": [
116 "Framework :: AWS CDK",
117 "Framework :: AWS CDK :: 1"
118 ],
119 "distName": "aws-cdk.cx-api",
120 "module": "aws_cdk.cx_api"
121 }
122 }
123 },
124 "@aws-cdk/region-info": {
125 "targets": {
126 "dotnet": {
127 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
128 "namespace": "Amazon.CDK.RegionInfo",
129 "packageId": "Amazon.CDK.RegionInfo"
130 },
131 "java": {
132 "maven": {
133 "artifactId": "cdk-region-info",
134 "groupId": "software.amazon.awscdk"
135 },
136 "package": "software.amazon.awscdk.regioninfo"
137 },
138 "js": {
139 "npm": "@aws-cdk/region-info"
140 },
141 "python": {
142 "classifiers": [
143 "Framework :: AWS CDK",
144 "Framework :: AWS CDK :: 1"
145 ],
146 "distName": "aws-cdk.region-info",
147 "module": "aws_cdk.region_info"
148 }
149 }
150 },
151 "constructs": {
152 "targets": {
153 "dotnet": {
154 "namespace": "Constructs",
155 "packageId": "Constructs"
156 },
157 "go": {
158 "moduleName": "github.com/aws/constructs-go"
159 },
160 "java": {
161 "maven": {
162 "artifactId": "constructs",
163 "groupId": "software.constructs"
164 },
165 "package": "software.constructs"
166 },
167 "js": {
168 "npm": "constructs"
169 },
170 "python": {
171 "distName": "constructs",
172 "module": "constructs"
173 }
174 }
175 }
176 },
177 "description": "The CDK Construct Library for AWS::CloudWatch",
178 "docs": {
179 "stability": "stable"
180 },
181 "homepage": "https://github.com/aws/aws-cdk",
182 "jsiiVersion": "1.60.0 (build ebcefe6)",
183 "keywords": [
184 "aws",
185 "cdk",
186 "constructs",
187 "cloudwatch"
188 ],
189 "license": "Apache-2.0",
190 "metadata": {
191 "jsii": {
192 "compiledWithDeprecationWarnings": true,
193 "pacmak": {
194 "hasDefaultInterfaces": true
195 },
196 "rosetta": {
197 "strict": true
198 }
199 }
200 },
201 "name": "@aws-cdk/aws-cloudwatch",
202 "readme": {
203 "markdown": "# Amazon CloudWatch Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)\n\n![cdk-constructs: Stable](https://img.shields.io/badge/cdk--constructs-stable-success.svg?style=for-the-badge)\n\n---\n\n<!--END STABILITY BANNER-->\n\n## Metric objects\n\nMetric objects represent a metric that is emitted by AWS services or your own\napplication, such as `CPUUsage`, `FailureCount` or `Bandwidth`.\n\nMetric objects can be constructed directly or are exposed by resources as\nattributes. Resources that expose metrics will have functions that look\nlike `metricXxx()` which will return a Metric object, initialized with defaults\nthat make sense.\n\nFor example, `lambda.Function` objects have the `fn.metricErrors()` method, which\nrepresents the amount of errors reported by that Lambda function:\n\n```ts\ndeclare const fn: lambda.Function;\n\nconst errors = fn.metricErrors();\n```\n\n`Metric` objects can be account and region aware. You can specify `account` and `region` as properties of the metric, or use the `metric.attachTo(Construct)` method. `metric.attachTo()` will automatically copy the `region` and `account` fields of the `Construct`, which can come from anywhere in the Construct tree.\n\nYou can also instantiate `Metric` objects to reference any\n[published metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)\nthat's not exposed using a convenience method on the CDK construct.\nFor example:\n\n```ts\nconst hostedZone = new route53.HostedZone(this, 'MyHostedZone', { zoneName: \"example.org\" });\nconst metric = new cloudwatch.Metric({\n namespace: 'AWS/Route53',\n metricName: 'DNSQueries',\n dimensionsMap: {\n HostedZoneId: hostedZone.hostedZoneId\n }\n});\n```\n\n### Instantiating a new Metric object\n\nIf you want to reference a metric that is not yet exposed by an existing construct,\nyou can instantiate a `Metric` object to represent it. For example:\n\n```ts\nconst metric = new cloudwatch.Metric({\n namespace: 'MyNamespace',\n metricName: 'MyMetric',\n dimensionsMap: {\n ProcessingStep: 'Download'\n }\n});\n```\n\n### Metric Math\n\nMath expressions are supported by instantiating the `MathExpression` class.\nFor example, a math expression that sums two other metrics looks like this:\n\n```ts\ndeclare const fn: lambda.Function;\n\nconst allProblems = new cloudwatch.MathExpression({\n expression: \"errors + throttles\",\n usingMetrics: {\n errors: fn.metricErrors(),\n faults: fn.metricThrottles(),\n }\n});\n```\n\nYou can use `MathExpression` objects like any other metric, including using\nthem in other math expressions:\n\n```ts\ndeclare const fn: lambda.Function;\ndeclare const allProblems: cloudwatch.MathExpression;\n\nconst problemPercentage = new cloudwatch.MathExpression({\n expression: \"(problems / invocations) * 100\",\n usingMetrics: {\n problems: allProblems,\n invocations: fn.metricInvocations()\n }\n});\n```\n\n### Search Expressions\n\nMath expressions also support search expressions. For example, the following\nsearch expression returns all CPUUtilization metrics that it finds, with the\ngraph showing the Average statistic with an aggregation period of 5 minutes:\n\n```ts\nconst cpuUtilization = new cloudwatch.MathExpression({\n expression: \"SEARCH('{AWS/EC2,InstanceId} MetricName=\\\"CPUUtilization\\\"', 'Average', 300)\",\n\n // Specifying '' as the label suppresses the default behavior\n // of using the expression as metric label. This is especially appropriate\n // when using expressions that return multiple time series (like SEARCH()\n // or METRICS()), to show the labels of the retrieved metrics only.\n label: '',\n});\n```\n\nCross-account and cross-region search expressions are also supported. Use\nthe `searchAccount` and `searchRegion` properties to specify the account\nand/or region to evaluate the search expression against.\n\n### Aggregation\n\nTo graph or alarm on metrics you must aggregate them first, using a function\nlike `Average` or a percentile function like `P99`. By default, most Metric objects\nreturned by CDK libraries will be configured as `Average` over `300 seconds` (5 minutes).\nThe exception is if the metric represents a count of discrete events, such as\nfailures. In that case, the Metric object will be configured as `Sum` over `300\nseconds`, i.e. it represents the number of times that event occurred over the\ntime period.\n\nIf you want to change the default aggregation of the Metric object (for example,\nthe function or the period), you can do so by passing additional parameters\nto the metric function call:\n\n```ts\ndeclare const fn: lambda.Function;\n\nconst minuteErrorRate = fn.metricErrors({\n statistic: 'avg',\n period: Duration.minutes(1),\n label: 'Lambda failure rate'\n});\n```\n\nThis function also allows changing the metric label or color (which will be\nuseful when embedding them in graphs, see below).\n\n> Rates versus Sums\n>\n> The reason for using `Sum` to count discrete events is that *some* events are\n> emitted as either `0` or `1` (for example `Errors` for a Lambda) and some are\n> only emitted as `1` (for example `NumberOfMessagesPublished` for an SNS\n> topic).\n>\n> In case `0`-metrics are emitted, it makes sense to take the `Average` of this\n> metric: the result will be the fraction of errors over all executions.\n>\n> If `0`-metrics are not emitted, the `Average` will always be equal to `1`,\n> and not be very useful.\n>\n> In order to simplify the mental model of `Metric` objects, we default to\n> aggregating using `Sum`, which will be the same for both metrics types. If you\n> happen to know the Metric you want to alarm on makes sense as a rate\n> (`Average`) you can always choose to change the statistic.\n\n### Labels\n\nMetric labels are displayed in the legend of graphs that include the metrics.\n\nYou can use [dynamic labels](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html)\nto show summary information about the displayed time series\nin the legend. For example, if you use:\n\n```ts\ndeclare const fn: lambda.Function;\n\nconst minuteErrorRate = fn.metricErrors({\n statistic: 'sum',\n period: Duration.hours(1),\n\n // Show the maximum hourly error count in the legend\n label: '[max: ${MAX}] Lambda failure rate',\n});\n```\n\nAs the metric label, the maximum value in the visible range will\nbe shown next to the time series name in the graph's legend.\n\nIf the metric is a math expression producing more than one time series, the\nmaximum will be individually calculated and shown for each time series produce\nby the math expression.\n\n## Alarms\n\nAlarms can be created on metrics in one of two ways. Either create an `Alarm`\nobject, passing the `Metric` object to set the alarm on:\n\n```ts\ndeclare const fn: lambda.Function;\n\nnew cloudwatch.Alarm(this, 'Alarm', {\n metric: fn.metricErrors(),\n threshold: 100,\n evaluationPeriods: 2,\n});\n```\n\nAlternatively, you can call `metric.createAlarm()`:\n\n```ts\ndeclare const fn: lambda.Function;\n\nfn.metricErrors().createAlarm(this, 'Alarm', {\n threshold: 100,\n evaluationPeriods: 2,\n});\n```\n\nThe most important properties to set while creating an Alarms are:\n\n- `threshold`: the value to compare the metric against.\n- `comparisonOperator`: the comparison operation to use, defaults to `metric >= threshold`.\n- `evaluationPeriods`: how many consecutive periods the metric has to be\n breaching the the threshold for the alarm to trigger.\n\nTo create a cross-account alarm, make sure you have enabled [cross-account functionality](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) in CloudWatch. Then, set the `account` property in the `Metric` object either manually or via the `metric.attachTo()` method.\n\n### Alarm Actions\n\nTo add actions to an alarm, use the integration classes from the\n`@aws-cdk/aws-cloudwatch-actions` package. For example, to post a message to\nan SNS topic when an alarm breaches, do the following:\n\n```ts\nimport * as cw_actions from '@aws-cdk/aws-cloudwatch-actions';\ndeclare const alarm: cloudwatch.Alarm;\n\nconst topic = new sns.Topic(this, 'Topic');\nalarm.addAlarmAction(new cw_actions.SnsAction(topic));\n```\n\n#### Notification formats\n\nAlarms can be created in one of two \"formats\":\n\n- With \"top-level parameters\" (these are the classic style of CloudWatch Alarms).\n- With a list of metrics specifications (these are the modern style of CloudWatch Alarms).\n\nFor backwards compatibility, CDK will try to create classic, top-level CloudWatch alarms\nas much as possible, unless you are using features that cannot be expressed in that format.\nFeatures that require the new-style alarm format are:\n\n- Metric math\n- Cross-account metrics\n- Labels\n\nThe difference between these two does not impact the functionality of the alarm\nin any way, *except* that the format of the notifications the Alarm generates is\ndifferent between them. This affects both the notifications sent out over SNS,\nas well as the EventBridge events generated by this Alarm. If you are writing\ncode to consume these notifications, be sure to handle both formats.\n\n### Composite Alarms\n\n[Composite Alarms](https://aws.amazon.com/about-aws/whats-new/2020/03/amazon-cloudwatch-now-allows-you-to-combine-multiple-alarms/)\ncan be created from existing Alarm resources.\n\n```ts\ndeclare const alarm1: cloudwatch.Alarm;\ndeclare const alarm2: cloudwatch.Alarm;\ndeclare const alarm3: cloudwatch.Alarm;\ndeclare const alarm4: cloudwatch.Alarm;\n\nconst alarmRule = cloudwatch.AlarmRule.anyOf(\n cloudwatch.AlarmRule.allOf(\n cloudwatch.AlarmRule.anyOf(\n alarm1,\n cloudwatch.AlarmRule.fromAlarm(alarm2, cloudwatch.AlarmState.OK),\n alarm3,\n ),\n cloudwatch.AlarmRule.not(cloudwatch.AlarmRule.fromAlarm(alarm4, cloudwatch.AlarmState.INSUFFICIENT_DATA)),\n ),\n cloudwatch.AlarmRule.fromBoolean(false),\n);\n\nnew cloudwatch.CompositeAlarm(this, 'MyAwesomeCompositeAlarm', {\n alarmRule,\n});\n```\n\n### A note on units\n\nIn CloudWatch, Metrics datums are emitted with units, such as `seconds` or\n`bytes`. When `Metric` objects are given a `unit` attribute, it will be used to\n*filter* the stream of metric datums for datums emitted using the same `unit`\nattribute.\n\nIn particular, the `unit` field is *not* used to rescale datums or alarm threshold\nvalues (for example, it cannot be used to specify an alarm threshold in\n*Megabytes* if the metric stream is being emitted as *bytes*).\n\nYou almost certainly don't want to specify the `unit` property when creating\n`Metric` objects (which will retrieve all datums regardless of their unit),\nunless you have very specific requirements. Note that in any case, CloudWatch\nonly supports filtering by `unit` for Alarms, not in Dashboard graphs.\n\nPlease see the following GitHub issue for a discussion on real unit\ncalculations in CDK: https://github.com/aws/aws-cdk/issues/5595\n\n## Dashboards\n\nDashboards are set of Widgets stored server-side which can be accessed quickly\nfrom the AWS console. Available widgets are graphs of a metric over time, the\ncurrent value of a metric, or a static piece of Markdown which explains what the\ngraphs mean.\n\nThe following widgets are available:\n\n- `GraphWidget` -- shows any number of metrics on both the left and right\n vertical axes.\n- `AlarmWidget` -- shows the graph and alarm line for a single alarm.\n- `SingleValueWidget` -- shows the current value of a set of metrics.\n- `TextWidget` -- shows some static Markdown.\n- `AlarmStatusWidget` -- shows the status of your alarms in a grid view.\n\n### Graph widget\n\nA graph widget can display any number of metrics on either the `left` or\n`right` vertical axis:\n\n```ts\ndeclare const dashboard: cloudwatch.Dashboard;\ndeclare const executionCountMetric: cloudwatch.Metric;\ndeclare const errorCountMetric: cloudwatch.Metric;\n\ndashboard.addWidgets(new cloudwatch.GraphWidget({\n title: \"Executions vs error rate\",\n\n left: [executionCountMetric],\n\n right: [errorCountMetric.with({\n statistic: \"average\",\n label: \"Error rate\",\n color: cloudwatch.Color.GREEN,\n })]\n}));\n```\n\nUsing the methods `addLeftMetric()` and `addRightMetric()` you can add metrics to a graph widget later on.\n\nGraph widgets can also display annotations attached to the left or the right y-axis.\n\n```ts\ndeclare const dashboard: cloudwatch.Dashboard;\n\ndashboard.addWidgets(new cloudwatch.GraphWidget({\n // ...\n\n leftAnnotations: [\n { value: 1800, label: Duration.minutes(30).toHumanString(), color: cloudwatch.Color.RED, },\n { value: 3600, label: '1 hour', color: '#2ca02c', }\n ],\n}));\n```\n\nThe graph legend can be adjusted from the default position at bottom of the widget.\n\n```ts\ndeclare const dashboard: cloudwatch.Dashboard;\n\ndashboard.addWidgets(new cloudwatch.GraphWidget({\n // ...\n\n legendPosition: cloudwatch.LegendPosition.RIGHT,\n}));\n```\n\nThe graph can publish live data within the last minute that has not been fully aggregated.\n\n```ts\ndeclare const dashboard: cloudwatch.Dashboard;\n\ndashboard.addWidgets(new cloudwatch.GraphWidget({\n // ...\n\n liveData: true,\n}));\n```\n\nThe graph view can be changed from default 'timeSeries' to 'bar' or 'pie'.\n\n```ts\ndeclare const dashboard: cloudwatch.Dashboard;\n\ndashboard.addWidgets(new cloudwatch.GraphWidget({\n // ...\n\n view: cloudwatch.GraphWidgetView.BAR,\n}));\n```\n\n### Alarm widget\n\nAn alarm widget shows the graph and the alarm line of a single alarm:\n\n```ts\ndeclare const dashboard: cloudwatch.Dashboard;\ndeclare const errorAlarm: cloudwatch.Alarm;\n\ndashboard.addWidgets(new cloudwatch.AlarmWidget({\n title: \"Errors\",\n alarm: errorAlarm,\n}));\n```\n\n### Single value widget\n\nA single-value widget shows the latest value of a set of metrics (as opposed\nto a graph of the value over time):\n\n```ts\ndeclare const dashboard: cloudwatch.Dashboard;\ndeclare const visitorCount: cloudwatch.Metric;\ndeclare const purchaseCount: cloudwatch.Metric;\n\ndashboard.addWidgets(new cloudwatch.SingleValueWidget({\n metrics: [visitorCount, purchaseCount],\n}));\n```\n\nShow as many digits as can fit, before rounding.\n\n```ts\ndeclare const dashboard: cloudwatch.Dashboard;\n\ndashboard.addWidgets(new cloudwatch.SingleValueWidget({\n metrics: [ /* ... */ ],\n\n fullPrecision: true,\n}));\n```\n\n### Text widget\n\nA text widget shows an arbitrary piece of MarkDown. Use this to add explanations\nto your dashboard:\n\n```ts\ndeclare const dashboard: cloudwatch.Dashboard;\n\ndashboard.addWidgets(new cloudwatch.TextWidget({\n markdown: '# Key Performance Indicators'\n}));\n```\n\n### Alarm Status widget\n\nAn alarm status widget displays instantly the status of any type of alarms and gives the\nability to aggregate one or more alarms together in a small surface.\n\n```ts\ndeclare const dashboard: cloudwatch.Dashboard;\ndeclare const errorAlarm: cloudwatch.Alarm;\n\ndashboard.addWidgets(\n new cloudwatch.AlarmStatusWidget({\n alarms: [errorAlarm],\n })\n);\n```\n\nAn alarm status widget only showing firing alarms, sorted by state and timestamp:\n\n```ts\ndeclare const dashboard: cloudwatch.Dashboard;\ndeclare const errorAlarm: cloudwatch.Alarm;\n\ndashboard.addWidgets(new cloudwatch.AlarmStatusWidget({\n title: \"Errors\",\n alarms: [errorAlarm],\n sortBy: cloudwatch.AlarmStatusWidgetSortBy.STATE_UPDATED_TIMESTAMP,\n states: [cloudwatch.AlarmState.ALARM],\n}));\n```\n\n### Query results widget\n\nA `LogQueryWidget` shows the results of a query from Logs Insights:\n\n```ts\ndeclare const dashboard: cloudwatch.Dashboard;\n\ndashboard.addWidgets(new cloudwatch.LogQueryWidget({\n logGroupNames: ['my-log-group'],\n view: cloudwatch.LogQueryVisualizationType.TABLE,\n // The lines will be automatically combined using '\\n|'.\n queryLines: [\n 'fields @message',\n 'filter @message like /Error/',\n ]\n}));\n```\n\n### Custom widget\n\nA `CustomWidget` shows the result of an AWS Lambda function:\n\n```ts\ndeclare const dashboard: cloudwatch.Dashboard;\n\n// Import or create a lambda function\nconst fn = lambda.Function.fromFunctionArn(\n dashboard,\n 'Function',\n 'arn:aws:lambda:us-east-1:123456789012:function:MyFn',\n);\n\ndashboard.addWidgets(new cloudwatch.CustomWidget({\n functionArn: fn.functionArn,\n title: 'My lambda baked widget',\n}));\n```\n\nYou can learn more about custom widgets in the [Amazon Cloudwatch User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/add_custom_widget_dashboard.html).\n\n### Dashboard Layout\n\nThe widgets on a dashboard are visually laid out in a grid that is 24 columns\nwide. Normally you specify X and Y coordinates for the widgets on a Dashboard,\nbut because this is inconvenient to do manually, the library contains a simple\nlayout system to help you lay out your dashboards the way you want them to.\n\nWidgets have a `width` and `height` property, and they will be automatically\nlaid out either horizontally or vertically stacked to fill out the available\nspace.\n\nWidgets are added to a Dashboard by calling `add(widget1, widget2, ...)`.\nWidgets given in the same call will be laid out horizontally. Widgets given\nin different calls will be laid out vertically. To make more complex layouts,\nyou can use the following widgets to pack widgets together in different ways:\n\n- `Column`: stack two or more widgets vertically.\n- `Row`: lay out two or more widgets horizontally.\n- `Spacer`: take up empty space\n"
204 },
205 "repository": {
206 "directory": "packages/@aws-cdk/aws-cloudwatch",
207 "type": "git",
208 "url": "https://github.com/aws/aws-cdk.git"
209 },
210 "schema": "jsii/0.10.0",
211 "targets": {
212 "dotnet": {
213 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
214 "namespace": "Amazon.CDK.AWS.CloudWatch",
215 "packageId": "Amazon.CDK.AWS.CloudWatch"
216 },
217 "java": {
218 "maven": {
219 "artifactId": "cloudwatch",
220 "groupId": "software.amazon.awscdk"
221 },
222 "package": "software.amazon.awscdk.services.cloudwatch"
223 },
224 "js": {
225 "npm": "@aws-cdk/aws-cloudwatch"
226 },
227 "python": {
228 "classifiers": [
229 "Framework :: AWS CDK",
230 "Framework :: AWS CDK :: 1"
231 ],
232 "distName": "aws-cdk.aws-cloudwatch",
233 "module": "aws_cdk.aws_cloudwatch"
234 }
235 },
236 "types": {
237 "@aws-cdk/aws-cloudwatch.Alarm": {
238 "assembly": "@aws-cdk/aws-cloudwatch",
239 "base": "@aws-cdk/aws-cloudwatch.AlarmBase",
240 "docs": {
241 "custom": {
242 "exampleMetadata": "infused"
243 },
244 "example": "import * as cloudwatch from '@aws-cdk/aws-cloudwatch';\n\ndeclare const alias: lambda.Alias;\nconst alarm = new cloudwatch.Alarm(this, 'Errors', {\n comparisonOperator: cloudwatch.ComparisonOperator.GREATER_THAN_THRESHOLD,\n threshold: 1,\n evaluationPeriods: 1,\n metric: alias.metricErrors(),\n});\nconst deploymentGroup = new codedeploy.LambdaDeploymentGroup(this, 'BlueGreenDeployment', {\n alias,\n deploymentConfig: codedeploy.LambdaDeploymentConfig.LINEAR_10PERCENT_EVERY_1MINUTE,\n alarms: [\n // pass some alarms when constructing the deployment group\n alarm,\n ],\n});\n\n// or add alarms to an existing group\ndeclare const blueGreenAlias: lambda.Alias;\ndeploymentGroup.addAlarm(new cloudwatch.Alarm(this, 'BlueGreenErrors', {\n comparisonOperator: cloudwatch.ComparisonOperator.GREATER_THAN_THRESHOLD,\n threshold: 1,\n evaluationPeriods: 1,\n metric: blueGreenAlias.metricErrors(),\n}));",
245 "stability": "stable",
246 "summary": "An alarm on a CloudWatch metric."
247 },
248 "fqn": "@aws-cdk/aws-cloudwatch.Alarm",
249 "initializer": {
250 "docs": {
251 "stability": "stable"
252 },
253 "locationInModule": {
254 "filename": "lib/alarm.ts",
255 "line": 146
256 },
257 "parameters": [
258 {
259 "name": "scope",
260 "type": {
261 "fqn": "constructs.Construct"
262 }
263 },
264 {
265 "name": "id",
266 "type": {
267 "primitive": "string"
268 }
269 },
270 {
271 "name": "props",
272 "type": {
273 "fqn": "@aws-cdk/aws-cloudwatch.AlarmProps"
274 }
275 }
276 ]
277 },
278 "kind": "class",
279 "locationInModule": {
280 "filename": "lib/alarm.ts",
281 "line": 105
282 },
283 "methods": [
284 {
285 "docs": {
286 "stability": "stable",
287 "summary": "Import an existing CloudWatch alarm provided an ARN."
288 },
289 "locationInModule": {
290 "filename": "lib/alarm.ts",
291 "line": 114
292 },
293 "name": "fromAlarmArn",
294 "parameters": [
295 {
296 "docs": {
297 "summary": "The parent creating construct (usually `this`)."
298 },
299 "name": "scope",
300 "type": {
301 "fqn": "constructs.Construct"
302 }
303 },
304 {
305 "docs": {
306 "summary": "The construct's name."
307 },
308 "name": "id",
309 "type": {
310 "primitive": "string"
311 }
312 },
313 {
314 "docs": {
315 "summary": "Alarm ARN (i.e. arn:aws:cloudwatch:<region>:<account-id>:alarm:Foo)."
316 },
317 "name": "alarmArn",
318 "type": {
319 "primitive": "string"
320 }
321 }
322 ],
323 "returns": {
324 "type": {
325 "fqn": "@aws-cdk/aws-cloudwatch.IAlarm"
326 }
327 },
328 "static": true
329 },
330 {
331 "docs": {
332 "remarks": "Typically the ARN of an SNS topic or ARN of an AutoScaling policy.",
333 "stability": "stable",
334 "summary": "Trigger this action if the alarm fires."
335 },
336 "locationInModule": {
337 "filename": "lib/alarm.ts",
338 "line": 237
339 },
340 "name": "addAlarmAction",
341 "overrides": "@aws-cdk/aws-cloudwatch.AlarmBase",
342 "parameters": [
343 {
344 "name": "actions",
345 "type": {
346 "fqn": "@aws-cdk/aws-cloudwatch.IAlarmAction"
347 },
348 "variadic": true
349 }
350 ],
351 "variadic": true
352 },
353 {
354 "docs": {
355 "remarks": "This is useful if you want to represent an Alarm in a non-AlarmWidget.\nAn `AlarmWidget` can directly show an alarm, but it can only show a\nsingle alarm and no other metrics. Instead, you can convert the alarm to\na HorizontalAnnotation and add it as an annotation to another graph.\n\nThis might be useful if:\n\n- You want to show multiple alarms inside a single graph, for example if\n you have both a \"small margin/long period\" alarm as well as a\n \"large margin/short period\" alarm.\n\n- You want to show an Alarm line in a graph with multiple metrics in it.",
356 "stability": "stable",
357 "summary": "Turn this alarm into a horizontal annotation."
358 },
359 "locationInModule": {
360 "filename": "lib/alarm.ts",
361 "line": 228
362 },
363 "name": "toAnnotation",
364 "returns": {
365 "type": {
366 "fqn": "@aws-cdk/aws-cloudwatch.HorizontalAnnotation"
367 }
368 }
369 }
370 ],
371 "name": "Alarm",
372 "properties": [
373 {
374 "docs": {
375 "custom": {
376 "attribute": "true"
377 },
378 "stability": "stable",
379 "summary": "ARN of this alarm."
380 },
381 "immutable": true,
382 "locationInModule": {
383 "filename": "lib/alarm.ts",
384 "line": 127
385 },
386 "name": "alarmArn",
387 "overrides": "@aws-cdk/aws-cloudwatch.AlarmBase",
388 "type": {
389 "primitive": "string"
390 }
391 },
392 {
393 "docs": {
394 "custom": {
395 "attribute": "true"
396 },
397 "stability": "stable",
398 "summary": "Name of this alarm."
399 },
400 "immutable": true,
401 "locationInModule": {
402 "filename": "lib/alarm.ts",
403 "line": 134
404 },
405 "name": "alarmName",
406 "overrides": "@aws-cdk/aws-cloudwatch.AlarmBase",
407 "type": {
408 "primitive": "string"
409 }
410 },
411 {
412 "docs": {
413 "stability": "stable",
414 "summary": "The metric object this alarm was based on."
415 },
416 "immutable": true,
417 "locationInModule": {
418 "filename": "lib/alarm.ts",
419 "line": 139
420 },
421 "name": "metric",
422 "type": {
423 "fqn": "@aws-cdk/aws-cloudwatch.IMetric"
424 }
425 }
426 ],
427 "symbolId": "lib/alarm:Alarm"
428 },
429 "@aws-cdk/aws-cloudwatch.AlarmActionConfig": {
430 "assembly": "@aws-cdk/aws-cloudwatch",
431 "datatype": true,
432 "docs": {
433 "stability": "stable",
434 "summary": "Properties for an alarm action.",
435 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst alarmActionConfig: cloudwatch.AlarmActionConfig = {\n alarmActionArn: 'alarmActionArn',\n};",
436 "custom": {
437 "exampleMetadata": "fixture=_generated"
438 }
439 },
440 "fqn": "@aws-cdk/aws-cloudwatch.AlarmActionConfig",
441 "kind": "interface",
442 "locationInModule": {
443 "filename": "lib/alarm-action.ts",
444 "line": 24
445 },
446 "name": "AlarmActionConfig",
447 "properties": [
448 {
449 "abstract": true,
450 "docs": {
451 "stability": "stable",
452 "summary": "Return the ARN that should be used for a CloudWatch Alarm action."
453 },
454 "immutable": true,
455 "locationInModule": {
456 "filename": "lib/alarm-action.ts",
457 "line": 28
458 },
459 "name": "alarmActionArn",
460 "type": {
461 "primitive": "string"
462 }
463 }
464 ],
465 "symbolId": "lib/alarm-action:AlarmActionConfig"
466 },
467 "@aws-cdk/aws-cloudwatch.AlarmBase": {
468 "abstract": true,
469 "assembly": "@aws-cdk/aws-cloudwatch",
470 "base": "@aws-cdk/core.Resource",
471 "docs": {
472 "stability": "stable",
473 "summary": "The base class for Alarm and CompositeAlarm resources."
474 },
475 "fqn": "@aws-cdk/aws-cloudwatch.AlarmBase",
476 "initializer": {
477 "docs": {
478 "stability": "stable"
479 },
480 "locationInModule": {
481 "filename": "lib/resource.ts",
482 "line": 150
483 },
484 "parameters": [
485 {
486 "name": "scope",
487 "type": {
488 "fqn": "constructs.Construct"
489 }
490 },
491 {
492 "name": "id",
493 "type": {
494 "primitive": "string"
495 }
496 },
497 {
498 "name": "props",
499 "optional": true,
500 "type": {
501 "fqn": "@aws-cdk/core.ResourceProps"
502 }
503 }
504 ]
505 },
506 "interfaces": [
507 "@aws-cdk/aws-cloudwatch.IAlarm"
508 ],
509 "kind": "class",
510 "locationInModule": {
511 "filename": "lib/alarm-base.ts",
512 "line": 38
513 },
514 "methods": [
515 {
516 "docs": {
517 "remarks": "Typically the ARN of an SNS topic or ARN of an AutoScaling policy.",
518 "stability": "stable",
519 "summary": "Trigger this action if the alarm fires."
520 },
521 "locationInModule": {
522 "filename": "lib/alarm-base.ts",
523 "line": 62
524 },
525 "name": "addAlarmAction",
526 "parameters": [
527 {
528 "name": "actions",
529 "type": {
530 "fqn": "@aws-cdk/aws-cloudwatch.IAlarmAction"
531 },
532 "variadic": true
533 }
534 ],
535 "variadic": true
536 },
537 {
538 "docs": {
539 "remarks": "Typically the ARN of an SNS topic or ARN of an AutoScaling policy.",
540 "stability": "stable",
541 "summary": "Trigger this action if there is insufficient data to evaluate the alarm."
542 },
543 "locationInModule": {
544 "filename": "lib/alarm-base.ts",
545 "line": 75
546 },
547 "name": "addInsufficientDataAction",
548 "parameters": [
549 {
550 "name": "actions",
551 "type": {
552 "fqn": "@aws-cdk/aws-cloudwatch.IAlarmAction"
553 },
554 "variadic": true
555 }
556 ],
557 "variadic": true
558 },
559 {
560 "docs": {
561 "remarks": "Typically the ARN of an SNS topic or ARN of an AutoScaling policy.",
562 "stability": "stable",
563 "summary": "Trigger this action if the alarm returns from breaching state into ok state."
564 },
565 "locationInModule": {
566 "filename": "lib/alarm-base.ts",
567 "line": 88
568 },
569 "name": "addOkAction",
570 "parameters": [
571 {
572 "name": "actions",
573 "type": {
574 "fqn": "@aws-cdk/aws-cloudwatch.IAlarmAction"
575 },
576 "variadic": true
577 }
578 ],
579 "variadic": true
580 },
581 {
582 "docs": {
583 "stability": "stable",
584 "summary": "AlarmRule indicating ALARM state for Alarm."
585 },
586 "locationInModule": {
587 "filename": "lib/alarm-base.ts",
588 "line": 53
589 },
590 "name": "renderAlarmRule",
591 "overrides": "@aws-cdk/aws-cloudwatch.IAlarmRule",
592 "returns": {
593 "type": {
594 "primitive": "string"
595 }
596 }
597 }
598 ],
599 "name": "AlarmBase",
600 "properties": [
601 {
602 "abstract": true,
603 "docs": {
604 "custom": {
605 "attribute": "true"
606 },
607 "stability": "stable",
608 "summary": "Alarm ARN (i.e. arn:aws:cloudwatch:<region>:<account-id>:alarm:Foo)."
609 },
610 "immutable": true,
611 "locationInModule": {
612 "filename": "lib/alarm-base.ts",
613 "line": 43
614 },
615 "name": "alarmArn",
616 "overrides": "@aws-cdk/aws-cloudwatch.IAlarm",
617 "type": {
618 "primitive": "string"
619 }
620 },
621 {
622 "abstract": true,
623 "docs": {
624 "stability": "stable",
625 "summary": "Name of the alarm."
626 },
627 "immutable": true,
628 "locationInModule": {
629 "filename": "lib/alarm-base.ts",
630 "line": 44
631 },
632 "name": "alarmName",
633 "overrides": "@aws-cdk/aws-cloudwatch.IAlarm",
634 "type": {
635 "primitive": "string"
636 }
637 },
638 {
639 "docs": {
640 "stability": "stable"
641 },
642 "locationInModule": {
643 "filename": "lib/alarm-base.ts",
644 "line": 46
645 },
646 "name": "alarmActionArns",
647 "optional": true,
648 "protected": true,
649 "type": {
650 "collection": {
651 "elementtype": {
652 "primitive": "string"
653 },
654 "kind": "array"
655 }
656 }
657 },
658 {
659 "docs": {
660 "stability": "stable"
661 },
662 "locationInModule": {
663 "filename": "lib/alarm-base.ts",
664 "line": 47
665 },
666 "name": "insufficientDataActionArns",
667 "optional": true,
668 "protected": true,
669 "type": {
670 "collection": {
671 "elementtype": {
672 "primitive": "string"
673 },
674 "kind": "array"
675 }
676 }
677 },
678 {
679 "docs": {
680 "stability": "stable"
681 },
682 "locationInModule": {
683 "filename": "lib/alarm-base.ts",
684 "line": 48
685 },
686 "name": "okActionArns",
687 "optional": true,
688 "protected": true,
689 "type": {
690 "collection": {
691 "elementtype": {
692 "primitive": "string"
693 },
694 "kind": "array"
695 }
696 }
697 }
698 ],
699 "symbolId": "lib/alarm-base:AlarmBase"
700 },
701 "@aws-cdk/aws-cloudwatch.AlarmProps": {
702 "assembly": "@aws-cdk/aws-cloudwatch",
703 "datatype": true,
704 "docs": {
705 "custom": {
706 "exampleMetadata": "infused"
707 },
708 "example": "import * as cloudwatch from '@aws-cdk/aws-cloudwatch';\n\ndeclare const alias: lambda.Alias;\nconst alarm = new cloudwatch.Alarm(this, 'Errors', {\n comparisonOperator: cloudwatch.ComparisonOperator.GREATER_THAN_THRESHOLD,\n threshold: 1,\n evaluationPeriods: 1,\n metric: alias.metricErrors(),\n});\nconst deploymentGroup = new codedeploy.LambdaDeploymentGroup(this, 'BlueGreenDeployment', {\n alias,\n deploymentConfig: codedeploy.LambdaDeploymentConfig.LINEAR_10PERCENT_EVERY_1MINUTE,\n alarms: [\n // pass some alarms when constructing the deployment group\n alarm,\n ],\n});\n\n// or add alarms to an existing group\ndeclare const blueGreenAlias: lambda.Alias;\ndeploymentGroup.addAlarm(new cloudwatch.Alarm(this, 'BlueGreenErrors', {\n comparisonOperator: cloudwatch.ComparisonOperator.GREATER_THAN_THRESHOLD,\n threshold: 1,\n evaluationPeriods: 1,\n metric: blueGreenAlias.metricErrors(),\n}));",
709 "stability": "stable",
710 "summary": "Properties for Alarms."
711 },
712 "fqn": "@aws-cdk/aws-cloudwatch.AlarmProps",
713 "interfaces": [
714 "@aws-cdk/aws-cloudwatch.CreateAlarmOptions"
715 ],
716 "kind": "interface",
717 "locationInModule": {
718 "filename": "lib/alarm.ts",
719 "line": 17
720 },
721 "name": "AlarmProps",
722 "properties": [
723 {
724 "abstract": true,
725 "docs": {
726 "remarks": "Metric objects can be obtained from most resources, or you can construct\ncustom Metric objects by instantiating one.",
727 "stability": "stable",
728 "summary": "The metric to add the alarm on."
729 },
730 "immutable": true,
731 "locationInModule": {
732 "filename": "lib/alarm.ts",
733 "line": 24
734 },
735 "name": "metric",
736 "type": {
737 "fqn": "@aws-cdk/aws-cloudwatch.IMetric"
738 }
739 }
740 ],
741 "symbolId": "lib/alarm:AlarmProps"
742 },
743 "@aws-cdk/aws-cloudwatch.AlarmRule": {
744 "assembly": "@aws-cdk/aws-cloudwatch",
745 "docs": {
746 "custom": {
747 "exampleMetadata": "infused"
748 },
749 "example": "declare const alarm1: cloudwatch.Alarm;\ndeclare const alarm2: cloudwatch.Alarm;\ndeclare const alarm3: cloudwatch.Alarm;\ndeclare const alarm4: cloudwatch.Alarm;\n\nconst alarmRule = cloudwatch.AlarmRule.anyOf(\n cloudwatch.AlarmRule.allOf(\n cloudwatch.AlarmRule.anyOf(\n alarm1,\n cloudwatch.AlarmRule.fromAlarm(alarm2, cloudwatch.AlarmState.OK),\n alarm3,\n ),\n cloudwatch.AlarmRule.not(cloudwatch.AlarmRule.fromAlarm(alarm4, cloudwatch.AlarmState.INSUFFICIENT_DATA)),\n ),\n cloudwatch.AlarmRule.fromBoolean(false),\n);\n\nnew cloudwatch.CompositeAlarm(this, 'MyAwesomeCompositeAlarm', {\n alarmRule,\n});",
750 "stability": "stable",
751 "summary": "Class with static functions to build AlarmRule for Composite Alarms."
752 },
753 "fqn": "@aws-cdk/aws-cloudwatch.AlarmRule",
754 "initializer": {
755 "docs": {
756 "stability": "stable"
757 }
758 },
759 "kind": "class",
760 "locationInModule": {
761 "filename": "lib/alarm-rule.ts",
762 "line": 39
763 },
764 "methods": [
765 {
766 "docs": {
767 "stability": "stable",
768 "summary": "function to join all provided AlarmRules with AND operator."
769 },
770 "locationInModule": {
771 "filename": "lib/alarm-rule.ts",
772 "line": 46
773 },
774 "name": "allOf",
775 "parameters": [
776 {
777 "docs": {
778 "summary": "IAlarmRules to be joined with AND operator."
779 },
780 "name": "operands",
781 "type": {
782 "fqn": "@aws-cdk/aws-cloudwatch.IAlarmRule"
783 },
784 "variadic": true
785 }
786 ],
787 "returns": {
788 "type": {
789 "fqn": "@aws-cdk/aws-cloudwatch.IAlarmRule"
790 }
791 },
792 "static": true,
793 "variadic": true
794 },
795 {
796 "docs": {
797 "stability": "stable",
798 "summary": "function to join all provided AlarmRules with OR operator."
799 },
800 "locationInModule": {
801 "filename": "lib/alarm-rule.ts",
802 "line": 55
803 },
804 "name": "anyOf",
805 "parameters": [
806 {
807 "docs": {
808 "summary": "IAlarmRules to be joined with OR operator."
809 },
810 "name": "operands",
811 "type": {
812 "fqn": "@aws-cdk/aws-cloudwatch.IAlarmRule"
813 },
814 "variadic": true
815 }
816 ],
817 "returns": {
818 "type": {
819 "fqn": "@aws-cdk/aws-cloudwatch.IAlarmRule"
820 }
821 },
822 "static": true,
823 "variadic": true
824 },
825 {
826 "docs": {
827 "stability": "stable",
828 "summary": "function to build Rule Expression for given IAlarm and AlarmState."
829 },
830 "locationInModule": {
831 "filename": "lib/alarm-rule.ts",
832 "line": 91
833 },
834 "name": "fromAlarm",
835 "parameters": [
836 {
837 "docs": {
838 "summary": "IAlarm to be used in Rule Expression."
839 },
840 "name": "alarm",
841 "type": {
842 "fqn": "@aws-cdk/aws-cloudwatch.IAlarm"
843 }
844 },
845 {
846 "docs": {
847 "summary": "AlarmState to be used in Rule Expression."
848 },
849 "name": "alarmState",
850 "type": {
851 "fqn": "@aws-cdk/aws-cloudwatch.AlarmState"
852 }
853 }
854 ],
855 "returns": {
856 "type": {
857 "fqn": "@aws-cdk/aws-cloudwatch.IAlarmRule"
858 }
859 },
860 "static": true
861 },
862 {
863 "docs": {
864 "stability": "stable",
865 "summary": "function to build TRUE/FALSE intent for Rule Expression."
866 },
867 "locationInModule": {
868 "filename": "lib/alarm-rule.ts",
869 "line": 77
870 },
871 "name": "fromBoolean",
872 "parameters": [
873 {
874 "docs": {
875 "summary": "boolean value to be used in rule expression."
876 },
877 "name": "value",
878 "type": {
879 "primitive": "boolean"
880 }
881 }
882 ],
883 "returns": {
884 "type": {
885 "fqn": "@aws-cdk/aws-cloudwatch.IAlarmRule"
886 }
887 },
888 "static": true
889 },
890 {
891 "docs": {
892 "stability": "stable",
893 "summary": "function to build Rule Expression for given Alarm Rule string."
894 },
895 "locationInModule": {
896 "filename": "lib/alarm-rule.ts",
897 "line": 104
898 },
899 "name": "fromString",
900 "parameters": [
901 {
902 "docs": {
903 "summary": "string to be used in Rule Expression."
904 },
905 "name": "alarmRule",
906 "type": {
907 "primitive": "string"
908 }
909 }
910 ],
911 "returns": {
912 "type": {
913 "fqn": "@aws-cdk/aws-cloudwatch.IAlarmRule"
914 }
915 },
916 "static": true
917 },
918 {
919 "docs": {
920 "stability": "stable",
921 "summary": "function to wrap provided AlarmRule in NOT operator."
922 },
923 "locationInModule": {
924 "filename": "lib/alarm-rule.ts",
925 "line": 64
926 },
927 "name": "not",
928 "parameters": [
929 {
930 "docs": {
931 "summary": "IAlarmRule to be wrapped in NOT operator."
932 },
933 "name": "operand",
934 "type": {
935 "fqn": "@aws-cdk/aws-cloudwatch.IAlarmRule"
936 }
937 }
938 ],
939 "returns": {
940 "type": {
941 "fqn": "@aws-cdk/aws-cloudwatch.IAlarmRule"
942 }
943 },
944 "static": true
945 }
946 ],
947 "name": "AlarmRule",
948 "symbolId": "lib/alarm-rule:AlarmRule"
949 },
950 "@aws-cdk/aws-cloudwatch.AlarmState": {
951 "assembly": "@aws-cdk/aws-cloudwatch",
952 "docs": {
953 "custom": {
954 "exampleMetadata": "infused"
955 },
956 "example": "declare const dashboard: cloudwatch.Dashboard;\ndeclare const errorAlarm: cloudwatch.Alarm;\n\ndashboard.addWidgets(new cloudwatch.AlarmStatusWidget({\n title: \"Errors\",\n alarms: [errorAlarm],\n sortBy: cloudwatch.AlarmStatusWidgetSortBy.STATE_UPDATED_TIMESTAMP,\n states: [cloudwatch.AlarmState.ALARM],\n}));",
957 "stability": "stable",
958 "summary": "Enumeration indicates state of Alarm used in building Alarm Rule."
959 },
960 "fqn": "@aws-cdk/aws-cloudwatch.AlarmState",
961 "kind": "enum",
962 "locationInModule": {
963 "filename": "lib/alarm-rule.ts",
964 "line": 6
965 },
966 "members": [
967 {
968 "docs": {
969 "stability": "stable",
970 "summary": "State indicates resource is in ALARM."
971 },
972 "name": "ALARM"
973 },
974 {
975 "docs": {
976 "stability": "stable",
977 "summary": "State indicates resource is not in ALARM."
978 },
979 "name": "OK"
980 },
981 {
982 "docs": {
983 "stability": "stable",
984 "summary": "State indicates there is not enough data to determine is resource is in ALARM."
985 },
986 "name": "INSUFFICIENT_DATA"
987 }
988 ],
989 "name": "AlarmState",
990 "symbolId": "lib/alarm-rule:AlarmState"
991 },
992 "@aws-cdk/aws-cloudwatch.AlarmStatusWidget": {
993 "assembly": "@aws-cdk/aws-cloudwatch",
994 "base": "@aws-cdk/aws-cloudwatch.ConcreteWidget",
995 "docs": {
996 "custom": {
997 "exampleMetadata": "infused"
998 },
999 "example": "declare const dashboard: cloudwatch.Dashboard;\ndeclare const errorAlarm: cloudwatch.Alarm;\n\ndashboard.addWidgets(\n new cloudwatch.AlarmStatusWidget({\n alarms: [errorAlarm],\n })\n);",
1000 "stability": "stable",
1001 "summary": "A dashboard widget that displays alarms in a grid view."
1002 },
1003 "fqn": "@aws-cdk/aws-cloudwatch.AlarmStatusWidget",
1004 "initializer": {
1005 "docs": {
1006 "stability": "stable"
1007 },
1008 "locationInModule": {
1009 "filename": "lib/alarm-status-widget.ts",
1010 "line": 83
1011 },
1012 "parameters": [
1013 {
1014 "name": "props",
1015 "type": {
1016 "fqn": "@aws-cdk/aws-cloudwatch.AlarmStatusWidgetProps"
1017 }
1018 }
1019 ]
1020 },
1021 "kind": "class",
1022 "locationInModule": {
1023 "filename": "lib/alarm-status-widget.ts",
1024 "line": 80
1025 },
1026 "methods": [
1027 {
1028 "docs": {
1029 "stability": "stable",
1030 "summary": "Place the widget at a given position."
1031 },
1032 "locationInModule": {
1033 "filename": "lib/alarm-status-widget.ts",
1034 "line": 88
1035 },
1036 "name": "position",
1037 "overrides": "@aws-cdk/aws-cloudwatch.ConcreteWidget",
1038 "parameters": [
1039 {
1040 "name": "x",
1041 "type": {
1042 "primitive": "number"
1043 }
1044 },
1045 {
1046 "name": "y",
1047 "type": {
1048 "primitive": "number"
1049 }
1050 }
1051 ]
1052 },
1053 {
1054 "docs": {
1055 "stability": "stable",
1056 "summary": "Return the widget JSON for use in the dashboard."
1057 },
1058 "locationInModule": {
1059 "filename": "lib/alarm-status-widget.ts",
1060 "line": 93
1061 },
1062 "name": "toJson",
1063 "overrides": "@aws-cdk/aws-cloudwatch.ConcreteWidget",
1064 "returns": {
1065 "type": {
1066 "collection": {
1067 "elementtype": {
1068 "primitive": "any"
1069 },
1070 "kind": "array"
1071 }
1072 }
1073 }
1074 }
1075 ],
1076 "name": "AlarmStatusWidget",
1077 "symbolId": "lib/alarm-status-widget:AlarmStatusWidget"
1078 },
1079 "@aws-cdk/aws-cloudwatch.AlarmStatusWidgetProps": {
1080 "assembly": "@aws-cdk/aws-cloudwatch",
1081 "datatype": true,
1082 "docs": {
1083 "custom": {
1084 "exampleMetadata": "infused"
1085 },
1086 "example": "declare const dashboard: cloudwatch.Dashboard;\ndeclare const errorAlarm: cloudwatch.Alarm;\n\ndashboard.addWidgets(\n new cloudwatch.AlarmStatusWidget({\n alarms: [errorAlarm],\n })\n);",
1087 "stability": "stable",
1088 "summary": "Properties for an Alarm Status Widget."
1089 },
1090 "fqn": "@aws-cdk/aws-cloudwatch.AlarmStatusWidgetProps",
1091 "kind": "interface",
1092 "locationInModule": {
1093 "filename": "lib/alarm-status-widget.ts",
1094 "line": 34
1095 },
1096 "name": "AlarmStatusWidgetProps",
1097 "properties": [
1098 {
1099 "abstract": true,
1100 "docs": {
1101 "stability": "stable",
1102 "summary": "CloudWatch Alarms to show in widget."
1103 },
1104 "immutable": true,
1105 "locationInModule": {
1106 "filename": "lib/alarm-status-widget.ts",
1107 "line": 38
1108 },
1109 "name": "alarms",
1110 "type": {
1111 "collection": {
1112 "elementtype": {
1113 "fqn": "@aws-cdk/aws-cloudwatch.IAlarm"
1114 },
1115 "kind": "array"
1116 }
1117 }
1118 },
1119 {
1120 "abstract": true,
1121 "docs": {
1122 "default": "3",
1123 "stability": "stable",
1124 "summary": "Height of the widget."
1125 },
1126 "immutable": true,
1127 "locationInModule": {
1128 "filename": "lib/alarm-status-widget.ts",
1129 "line": 56
1130 },
1131 "name": "height",
1132 "optional": true,
1133 "type": {
1134 "primitive": "number"
1135 }
1136 },
1137 {
1138 "abstract": true,
1139 "docs": {
1140 "default": "- alphabetical order",
1141 "stability": "stable",
1142 "summary": "Specifies how to sort the alarms in the widget."
1143 },
1144 "immutable": true,
1145 "locationInModule": {
1146 "filename": "lib/alarm-status-widget.ts",
1147 "line": 63
1148 },
1149 "name": "sortBy",
1150 "optional": true,
1151 "type": {
1152 "fqn": "@aws-cdk/aws-cloudwatch.AlarmStatusWidgetSortBy"
1153 }
1154 },
1155 {
1156 "abstract": true,
1157 "docs": {
1158 "default": "- all the alarms specified in alarms are displayed.",
1159 "remarks": "You can specify one or more alarm states in the value for this field.\nThe alarm states that you can specify are ALARM, INSUFFICIENT_DATA, and OK.\n\nIf you omit this field or specify an empty array, all the alarms specifed in alarms are displayed.",
1160 "stability": "stable",
1161 "summary": "Use this field to filter the list of alarms displayed in the widget to only those alarms currently in the specified states."
1162 },
1163 "immutable": true,
1164 "locationInModule": {
1165 "filename": "lib/alarm-status-widget.ts",
1166 "line": 74
1167 },
1168 "name": "states",
1169 "optional": true,
1170 "type": {
1171 "collection": {
1172 "elementtype": {
1173 "fqn": "@aws-cdk/aws-cloudwatch.AlarmState"
1174 },
1175 "kind": "array"
1176 }
1177 }
1178 },
1179 {
1180 "abstract": true,
1181 "docs": {
1182 "default": "'Alarm Status'",
1183 "stability": "stable",
1184 "summary": "The title of the widget."
1185 },
1186 "immutable": true,
1187 "locationInModule": {
1188 "filename": "lib/alarm-status-widget.ts",
1189 "line": 44
1190 },
1191 "name": "title",
1192 "optional": true,
1193 "type": {
1194 "primitive": "string"
1195 }
1196 },
1197 {
1198 "abstract": true,
1199 "docs": {
1200 "default": "6",
1201 "stability": "stable",
1202 "summary": "Width of the widget, in a grid of 24 units wide."
1203 },
1204 "immutable": true,
1205 "locationInModule": {
1206 "filename": "lib/alarm-status-widget.ts",
1207 "line": 50
1208 },
1209 "name": "width",
1210 "optional": true,
1211 "type": {
1212 "primitive": "number"
1213 }
1214 }
1215 ],
1216 "symbolId": "lib/alarm-status-widget:AlarmStatusWidgetProps"
1217 },
1218 "@aws-cdk/aws-cloudwatch.AlarmStatusWidgetSortBy": {
1219 "assembly": "@aws-cdk/aws-cloudwatch",
1220 "docs": {
1221 "custom": {
1222 "exampleMetadata": "infused"
1223 },
1224 "example": "declare const dashboard: cloudwatch.Dashboard;\ndeclare const errorAlarm: cloudwatch.Alarm;\n\ndashboard.addWidgets(new cloudwatch.AlarmStatusWidget({\n title: \"Errors\",\n alarms: [errorAlarm],\n sortBy: cloudwatch.AlarmStatusWidgetSortBy.STATE_UPDATED_TIMESTAMP,\n states: [cloudwatch.AlarmState.ALARM],\n}));",
1225 "stability": "stable",
1226 "summary": "The sort possibilities for AlarmStatusWidgets."
1227 },
1228 "fqn": "@aws-cdk/aws-cloudwatch.AlarmStatusWidgetSortBy",
1229 "kind": "enum",
1230 "locationInModule": {
1231 "filename": "lib/alarm-status-widget.ts",
1232 "line": 9
1233 },
1234 "members": [
1235 {
1236 "docs": {
1237 "stability": "stable",
1238 "summary": "Choose DEFAULT to sort them in alphabetical order by alarm name."
1239 },
1240 "name": "DEFAULT"
1241 },
1242 {
1243 "docs": {
1244 "remarks": "Within each group, the alarms are sorted by when they last changed state, with more recent state changes listed first.",
1245 "stability": "stable",
1246 "summary": "Choose STATE_UPDATED_TIMESTAMP to sort them first by alarm state, with alarms in ALARM state first, INSUFFICIENT_DATA alarms next, and OK alarms last."
1247 },
1248 "name": "STATE_UPDATED_TIMESTAMP"
1249 },
1250 {
1251 "docs": {
1252 "remarks": "The alarm that changed state most recently is listed first.",
1253 "stability": "stable",
1254 "summary": "Choose TIMESTAMP to sort them by the time when the alarms most recently changed state, no matter the current alarm state."
1255 },
1256 "name": "TIMESTAMP"
1257 }
1258 ],
1259 "name": "AlarmStatusWidgetSortBy",
1260 "symbolId": "lib/alarm-status-widget:AlarmStatusWidgetSortBy"
1261 },
1262 "@aws-cdk/aws-cloudwatch.AlarmWidget": {
1263 "assembly": "@aws-cdk/aws-cloudwatch",
1264 "base": "@aws-cdk/aws-cloudwatch.ConcreteWidget",
1265 "docs": {
1266 "custom": {
1267 "exampleMetadata": "infused"
1268 },
1269 "example": "declare const dashboard: cloudwatch.Dashboard;\ndeclare const errorAlarm: cloudwatch.Alarm;\n\ndashboard.addWidgets(new cloudwatch.AlarmWidget({\n title: \"Errors\",\n alarm: errorAlarm,\n}));",
1270 "stability": "stable",
1271 "summary": "Display the metric associated with an alarm, including the alarm line."
1272 },
1273 "fqn": "@aws-cdk/aws-cloudwatch.AlarmWidget",
1274 "initializer": {
1275 "docs": {
1276 "stability": "stable"
1277 },
1278 "locationInModule": {
1279 "filename": "lib/graph.ts",
1280 "line": 97
1281 },
1282 "parameters": [
1283 {
1284 "name": "props",
1285 "type": {
1286 "fqn": "@aws-cdk/aws-cloudwatch.AlarmWidgetProps"
1287 }
1288 }
1289 ]
1290 },
1291 "kind": "class",
1292 "locationInModule": {
1293 "filename": "lib/graph.ts",
1294 "line": 94
1295 },
1296 "methods": [
1297 {
1298 "docs": {
1299 "stability": "stable",
1300 "summary": "Return the widget JSON for use in the dashboard."
1301 },
1302 "locationInModule": {
1303 "filename": "lib/graph.ts",
1304 "line": 102
1305 },
1306 "name": "toJson",
1307 "overrides": "@aws-cdk/aws-cloudwatch.ConcreteWidget",
1308 "returns": {
1309 "type": {
1310 "collection": {
1311 "elementtype": {
1312 "primitive": "any"
1313 },
1314 "kind": "array"
1315 }
1316 }
1317 }
1318 }
1319 ],
1320 "name": "AlarmWidget",
1321 "symbolId": "lib/graph:AlarmWidget"
1322 },
1323 "@aws-cdk/aws-cloudwatch.AlarmWidgetProps": {
1324 "assembly": "@aws-cdk/aws-cloudwatch",
1325 "datatype": true,
1326 "docs": {
1327 "custom": {
1328 "exampleMetadata": "infused"
1329 },
1330 "example": "declare const dashboard: cloudwatch.Dashboard;\ndeclare const errorAlarm: cloudwatch.Alarm;\n\ndashboard.addWidgets(new cloudwatch.AlarmWidget({\n title: \"Errors\",\n alarm: errorAlarm,\n}));",
1331 "stability": "stable",
1332 "summary": "Properties for an AlarmWidget."
1333 },
1334 "fqn": "@aws-cdk/aws-cloudwatch.AlarmWidgetProps",
1335 "interfaces": [
1336 "@aws-cdk/aws-cloudwatch.MetricWidgetProps"
1337 ],
1338 "kind": "interface",
1339 "locationInModule": {
1340 "filename": "lib/graph.ts",
1341 "line": 77
1342 },
1343 "name": "AlarmWidgetProps",
1344 "properties": [
1345 {
1346 "abstract": true,
1347 "docs": {
1348 "stability": "stable",
1349 "summary": "The alarm to show."
1350 },
1351 "immutable": true,
1352 "locationInModule": {
1353 "filename": "lib/graph.ts",
1354 "line": 81
1355 },
1356 "name": "alarm",
1357 "type": {
1358 "fqn": "@aws-cdk/aws-cloudwatch.IAlarm"
1359 }
1360 },
1361 {
1362 "abstract": true,
1363 "docs": {
1364 "default": "- No minimum or maximum values for the left Y-axis",
1365 "stability": "stable",
1366 "summary": "Left Y axis."
1367 },
1368 "immutable": true,
1369 "locationInModule": {
1370 "filename": "lib/graph.ts",
1371 "line": 88
1372 },
1373 "name": "leftYAxis",
1374 "optional": true,
1375 "type": {
1376 "fqn": "@aws-cdk/aws-cloudwatch.YAxisProps"
1377 }
1378 }
1379 ],
1380 "symbolId": "lib/graph:AlarmWidgetProps"
1381 },
1382 "@aws-cdk/aws-cloudwatch.CfnAlarm": {
1383 "assembly": "@aws-cdk/aws-cloudwatch",
1384 "base": "@aws-cdk/core.CfnResource",
1385 "docs": {
1386 "custom": {
1387 "cloudformationResource": "AWS::CloudWatch::Alarm",
1388 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html",
1389 "exampleMetadata": "fixture=_generated"
1390 },
1391 "remarks": "The `AWS::CloudWatch::Alarm` type specifies an alarm and associates it with the specified metric or metric math expression.\n\nWhen 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.\n\nWhen you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.",
1392 "stability": "external",
1393 "summary": "A CloudFormation `AWS::CloudWatch::Alarm`.",
1394 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst cfnAlarm = new cloudwatch.CfnAlarm(this, 'MyCfnAlarm', {\n comparisonOperator: 'comparisonOperator',\n evaluationPeriods: 123,\n\n // the properties below are optional\n actionsEnabled: false,\n alarmActions: ['alarmActions'],\n alarmDescription: 'alarmDescription',\n alarmName: 'alarmName',\n datapointsToAlarm: 123,\n dimensions: [{\n name: 'name',\n value: 'value',\n }],\n evaluateLowSampleCountPercentile: 'evaluateLowSampleCountPercentile',\n extendedStatistic: 'extendedStatistic',\n insufficientDataActions: ['insufficientDataActions'],\n metricName: 'metricName',\n metrics: [{\n id: 'id',\n\n // the properties below are optional\n accountId: 'accountId',\n expression: 'expression',\n label: 'label',\n metricStat: {\n metric: {\n dimensions: [{\n name: 'name',\n value: 'value',\n }],\n metricName: 'metricName',\n namespace: 'namespace',\n },\n period: 123,\n stat: 'stat',\n\n // the properties below are optional\n unit: 'unit',\n },\n period: 123,\n returnData: false,\n }],\n namespace: 'namespace',\n okActions: ['okActions'],\n period: 123,\n statistic: 'statistic',\n threshold: 123,\n thresholdMetricId: 'thresholdMetricId',\n treatMissingData: 'treatMissingData',\n unit: 'unit',\n});"
1395 },
1396 "fqn": "@aws-cdk/aws-cloudwatch.CfnAlarm",
1397 "initializer": {
1398 "docs": {
1399 "stability": "external",
1400 "summary": "Create a new `AWS::CloudWatch::Alarm`."
1401 },
1402 "locationInModule": {
1403 "filename": "lib/cloudwatch.generated.ts",
1404 "line": 531
1405 },
1406 "parameters": [
1407 {
1408 "docs": {
1409 "summary": "- scope in which this resource is defined."
1410 },
1411 "name": "scope",
1412 "type": {
1413 "fqn": "@aws-cdk/core.Construct"
1414 }
1415 },
1416 {
1417 "docs": {
1418 "summary": "- scoped id of the resource."
1419 },
1420 "name": "id",
1421 "type": {
1422 "primitive": "string"
1423 }
1424 },
1425 {
1426 "docs": {
1427 "summary": "- resource properties."
1428 },
1429 "name": "props",
1430 "type": {
1431 "fqn": "@aws-cdk/aws-cloudwatch.CfnAlarmProps"
1432 }
1433 }
1434 ]
1435 },
1436 "interfaces": [
1437 "@aws-cdk/core.IInspectable"
1438 ],
1439 "kind": "class",
1440 "locationInModule": {
1441 "filename": "lib/cloudwatch.generated.ts",
1442 "line": 318
1443 },
1444 "methods": [
1445 {
1446 "docs": {
1447 "stability": "external",
1448 "summary": "Examines the CloudFormation resource and discloses attributes."
1449 },
1450 "locationInModule": {
1451 "filename": "lib/cloudwatch.generated.ts",
1452 "line": 566
1453 },
1454 "name": "inspect",
1455 "overrides": "@aws-cdk/core.IInspectable",
1456 "parameters": [
1457 {
1458 "docs": {
1459 "summary": "- tree inspector to collect and process attributes."
1460 },
1461 "name": "inspector",
1462 "type": {
1463 "fqn": "@aws-cdk/core.TreeInspector"
1464 }
1465 }
1466 ]
1467 },
1468 {
1469 "docs": {
1470 "stability": "external"
1471 },
1472 "locationInModule": {
1473 "filename": "lib/cloudwatch.generated.ts",
1474 "line": 597
1475 },
1476 "name": "renderProperties",
1477 "overrides": "@aws-cdk/core.CfnResource",
1478 "parameters": [
1479 {
1480 "name": "props",
1481 "type": {
1482 "collection": {
1483 "elementtype": {
1484 "primitive": "any"
1485 },
1486 "kind": "map"
1487 }
1488 }
1489 }
1490 ],
1491 "protected": true,
1492 "returns": {
1493 "type": {
1494 "collection": {
1495 "elementtype": {
1496 "primitive": "any"
1497 },
1498 "kind": "map"
1499 }
1500 }
1501 }
1502 }
1503 ],
1504 "name": "CfnAlarm",
1505 "properties": [
1506 {
1507 "const": true,
1508 "docs": {
1509 "stability": "external",
1510 "summary": "The CloudFormation resource type name for this resource class."
1511 },
1512 "immutable": true,
1513 "locationInModule": {
1514 "filename": "lib/cloudwatch.generated.ts",
1515 "line": 322
1516 },
1517 "name": "CFN_RESOURCE_TYPE_NAME",
1518 "static": true,
1519 "type": {
1520 "primitive": "string"
1521 }
1522 },
1523 {
1524 "docs": {
1525 "custom": {
1526 "cloudformationAttribute": "Arn"
1527 },
1528 "stability": "external",
1529 "summary": "The ARN of the CloudWatch alarm, such as `arn:aws:cloudwatch:us-west-2:123456789012:alarm:myCloudWatchAlarm-CPUAlarm-UXMMZK36R55Z` ."
1530 },
1531 "immutable": true,
1532 "locationInModule": {
1533 "filename": "lib/cloudwatch.generated.ts",
1534 "line": 347
1535 },
1536 "name": "attrArn",
1537 "type": {
1538 "primitive": "string"
1539 }
1540 },
1541 {
1542 "docs": {
1543 "stability": "external"
1544 },
1545 "immutable": true,
1546 "locationInModule": {
1547 "filename": "lib/cloudwatch.generated.ts",
1548 "line": 571
1549 },
1550 "name": "cfnProperties",
1551 "overrides": "@aws-cdk/core.CfnResource",
1552 "protected": true,
1553 "type": {
1554 "collection": {
1555 "elementtype": {
1556 "primitive": "any"
1557 },
1558 "kind": "map"
1559 }
1560 }
1561 },
1562 {
1563 "docs": {
1564 "custom": {
1565 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-comparisonoperator"
1566 },
1567 "remarks": "The specified statistic value is used as the first operand.\n\nYou can specify the following values: `GreaterThanThreshold` , `GreaterThanOrEqualToThreshold` , `LessThanThreshold` , or `LessThanOrEqualToThreshold` .",
1568 "stability": "external",
1569 "summary": "The arithmetic operation to use when comparing the specified statistic and threshold."
1570 },
1571 "locationInModule": {
1572 "filename": "lib/cloudwatch.generated.ts",
1573 "line": 356
1574 },
1575 "name": "comparisonOperator",
1576 "type": {
1577 "primitive": "string"
1578 }
1579 },
1580 {
1581 "docs": {
1582 "custom": {
1583 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-evaluationperiods"
1584 },
1585 "remarks": "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.\n\nFor more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *Amazon CloudWatch User Guide* .",
1586 "stability": "external",
1587 "summary": "The number of periods over which data is compared to the specified threshold."
1588 },
1589 "locationInModule": {
1590 "filename": "lib/cloudwatch.generated.ts",
1591 "line": 365
1592 },
1593 "name": "evaluationPeriods",
1594 "type": {
1595 "primitive": "number"
1596 }
1597 },
1598 {
1599 "docs": {
1600 "custom": {
1601 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-actionsenabled"
1602 },
1603 "remarks": "The default is TRUE.",
1604 "stability": "external",
1605 "summary": "Indicates whether actions should be executed during any changes to the alarm state."
1606 },
1607 "locationInModule": {
1608 "filename": "lib/cloudwatch.generated.ts",
1609 "line": 372
1610 },
1611 "name": "actionsEnabled",
1612 "optional": true,
1613 "type": {
1614 "union": {
1615 "types": [
1616 {
1617 "primitive": "boolean"
1618 },
1619 {
1620 "fqn": "@aws-cdk/core.IResolvable"
1621 }
1622 ]
1623 }
1624 }
1625 },
1626 {
1627 "docs": {
1628 "custom": {
1629 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmactions"
1630 },
1631 "remarks": "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* .",
1632 "stability": "external",
1633 "summary": "The list of actions to execute when this alarm transitions into an ALARM state from any other state."
1634 },
1635 "locationInModule": {
1636 "filename": "lib/cloudwatch.generated.ts",
1637 "line": 379
1638 },
1639 "name": "alarmActions",
1640 "optional": true,
1641 "type": {
1642 "collection": {
1643 "elementtype": {
1644 "primitive": "string"
1645 },
1646 "kind": "array"
1647 }
1648 }
1649 },
1650 {
1651 "docs": {
1652 "custom": {
1653 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmdescription"
1654 },
1655 "stability": "external",
1656 "summary": "The description of the alarm."
1657 },
1658 "locationInModule": {
1659 "filename": "lib/cloudwatch.generated.ts",
1660 "line": 386
1661 },
1662 "name": "alarmDescription",
1663 "optional": true,
1664 "type": {
1665 "primitive": "string"
1666 }
1667 },
1668 {
1669 "docs": {
1670 "custom": {
1671 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmname"
1672 },
1673 "remarks": "If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the alarm name.\n\n> 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.",
1674 "stability": "external",
1675 "summary": "The name of the alarm."
1676 },
1677 "locationInModule": {
1678 "filename": "lib/cloudwatch.generated.ts",
1679 "line": 395
1680 },
1681 "name": "alarmName",
1682 "optional": true,
1683 "type": {
1684 "primitive": "string"
1685 }
1686 },
1687 {
1688 "docs": {
1689 "custom": {
1690 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarm-datapointstoalarm"
1691 },
1692 "remarks": "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* .\n\nIf 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.",
1693 "stability": "external",
1694 "summary": "The number of datapoints that must be breaching to trigger the alarm."
1695 },
1696 "locationInModule": {
1697 "filename": "lib/cloudwatch.generated.ts",
1698 "line": 404
1699 },
1700 "name": "datapointsToAlarm",
1701 "optional": true,
1702 "type": {
1703 "primitive": "number"
1704 }
1705 },
1706 {
1707 "docs": {
1708 "custom": {
1709 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-dimension"
1710 },
1711 "remarks": "For an alarm based on a math expression, you can't specify `Dimensions` . Instead, you use `Metrics` .",
1712 "stability": "external",
1713 "summary": "The dimensions for the metric associated with the alarm."
1714 },
1715 "locationInModule": {
1716 "filename": "lib/cloudwatch.generated.ts",
1717 "line": 411
1718 },
1719 "name": "dimensions",
1720 "optional": true,
1721 "type": {
1722 "union": {
1723 "types": [
1724 {
1725 "fqn": "@aws-cdk/core.IResolvable"
1726 },
1727 {
1728 "collection": {
1729 "elementtype": {
1730 "union": {
1731 "types": [
1732 {
1733 "fqn": "@aws-cdk/core.IResolvable"
1734 },
1735 {
1736 "fqn": "@aws-cdk/aws-cloudwatch.CfnAlarm.DimensionProperty"
1737 }
1738 ]
1739 }
1740 },
1741 "kind": "array"
1742 }
1743 }
1744 ]
1745 }
1746 }
1747 },
1748 {
1749 "docs": {
1750 "custom": {
1751 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-evaluatelowsamplecountpercentile"
1752 },
1753 "remarks": "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.",
1754 "stability": "external",
1755 "summary": "Used only for alarms based on percentiles."
1756 },
1757 "locationInModule": {
1758 "filename": "lib/cloudwatch.generated.ts",
1759 "line": 418
1760 },
1761 "name": "evaluateLowSampleCountPercentile",
1762 "optional": true,
1763 "type": {
1764 "primitive": "string"
1765 }
1766 },
1767 {
1768 "docs": {
1769 "custom": {
1770 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-extendedstatistic"
1771 },
1772 "remarks": "For an alarm based on a metric, you must specify either `Statistic` or `ExtendedStatistic` but not both.\n\nFor an alarm based on a math expression, you can't specify `ExtendedStatistic` . Instead, you use `Metrics` .",
1773 "stability": "external",
1774 "summary": "The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100."
1775 },
1776 "locationInModule": {
1777 "filename": "lib/cloudwatch.generated.ts",
1778 "line": 429
1779 },
1780 "name": "extendedStatistic",
1781 "optional": true,
1782 "type": {
1783 "primitive": "string"
1784 }
1785 },
1786 {
1787 "docs": {
1788 "custom": {
1789 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-insufficientdataactions"
1790 },
1791 "remarks": "Each action is specified as an Amazon Resource Name (ARN).",
1792 "stability": "external",
1793 "summary": "The actions to execute when this alarm transitions to the `INSUFFICIENT_DATA` state from any other state."
1794 },
1795 "locationInModule": {
1796 "filename": "lib/cloudwatch.generated.ts",
1797 "line": 436
1798 },
1799 "name": "insufficientDataActions",
1800 "optional": true,
1801 "type": {
1802 "collection": {
1803 "elementtype": {
1804 "primitive": "string"
1805 },
1806 "kind": "array"
1807 }
1808 }
1809 },
1810 {
1811 "docs": {
1812 "custom": {
1813 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-metricname"
1814 },
1815 "remarks": "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` .",
1816 "stability": "external",
1817 "summary": "The name of the metric associated with the alarm."
1818 },
1819 "locationInModule": {
1820 "filename": "lib/cloudwatch.generated.ts",
1821 "line": 443
1822 },
1823 "name": "metricName",
1824 "optional": true,
1825 "type": {
1826 "primitive": "string"
1827 }
1828 },
1829 {
1830 "docs": {
1831 "custom": {
1832 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarm-metrics"
1833 },
1834 "remarks": "Each item in the array either retrieves a metric or performs a math expression.\n\nIf you specify the `Metrics` parameter, you cannot specify `MetricName` , `Dimensions` , `Period` , `Namespace` , `Statistic` , `ExtendedStatistic` , or `Unit` .",
1835 "stability": "external",
1836 "summary": "An array that enables you to create an alarm based on the result of a metric math expression."
1837 },
1838 "locationInModule": {
1839 "filename": "lib/cloudwatch.generated.ts",
1840 "line": 452
1841 },
1842 "name": "metrics",
1843 "optional": true,
1844 "type": {
1845 "union": {
1846 "types": [
1847 {
1848 "fqn": "@aws-cdk/core.IResolvable"
1849 },
1850 {
1851 "collection": {
1852 "elementtype": {
1853 "union": {
1854 "types": [
1855 {
1856 "fqn": "@aws-cdk/core.IResolvable"
1857 },
1858 {
1859 "fqn": "@aws-cdk/aws-cloudwatch.CfnAlarm.MetricDataQueryProperty"
1860 }
1861 ]
1862 }
1863 },
1864 "kind": "array"
1865 }
1866 }
1867 ]
1868 }
1869 }
1870 },
1871 {
1872 "docs": {
1873 "custom": {
1874 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-namespace"
1875 },
1876 "remarks": "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.\n\nFor 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)",
1877 "stability": "external",
1878 "summary": "The namespace of the metric associated with the alarm."
1879 },
1880 "locationInModule": {
1881 "filename": "lib/cloudwatch.generated.ts",
1882 "line": 461
1883 },
1884 "name": "namespace",
1885 "optional": true,
1886 "type": {
1887 "primitive": "string"
1888 }
1889 },
1890 {
1891 "docs": {
1892 "custom": {
1893 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-okactions"
1894 },
1895 "remarks": "Each action is specified as an Amazon Resource Name (ARN).",
1896 "stability": "external",
1897 "summary": "The actions to execute when this alarm transitions to the `OK` state from any other state."
1898 },
1899 "locationInModule": {
1900 "filename": "lib/cloudwatch.generated.ts",
1901 "line": 468
1902 },
1903 "name": "okActions",
1904 "optional": true,
1905 "type": {
1906 "collection": {
1907 "elementtype": {
1908 "primitive": "string"
1909 },
1910 "kind": "array"
1911 }
1912 }
1913 },
1914 {
1915 "docs": {
1916 "custom": {
1917 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-period"
1918 },
1919 "remarks": "This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.\n\nFor an alarm based on a math expression, you can't specify `Period` , and instead you use the `Metrics` parameter.\n\n*Minimum:* 10",
1920 "stability": "external",
1921 "summary": "The period, in seconds, over which the statistic is applied."
1922 },
1923 "locationInModule": {
1924 "filename": "lib/cloudwatch.generated.ts",
1925 "line": 479
1926 },
1927 "name": "period",
1928 "optional": true,
1929 "type": {
1930 "primitive": "number"
1931 }
1932 },
1933 {
1934 "docs": {
1935 "custom": {
1936 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-statistic"
1937 },
1938 "remarks": "For an alarm based on a metric, you must specify either `Statistic` or `ExtendedStatistic` but not both.\n\nFor an alarm based on a math expression, you can't specify `Statistic` . Instead, you use `Metrics` .",
1939 "stability": "external",
1940 "summary": "The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use `ExtendedStatistic` ."
1941 },
1942 "locationInModule": {
1943 "filename": "lib/cloudwatch.generated.ts",
1944 "line": 490
1945 },
1946 "name": "statistic",
1947 "optional": true,
1948 "type": {
1949 "primitive": "string"
1950 }
1951 },
1952 {
1953 "docs": {
1954 "custom": {
1955 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-threshold"
1956 },
1957 "stability": "external",
1958 "summary": "The value to compare with the specified statistic."
1959 },
1960 "locationInModule": {
1961 "filename": "lib/cloudwatch.generated.ts",
1962 "line": 497
1963 },
1964 "name": "threshold",
1965 "optional": true,
1966 "type": {
1967 "primitive": "number"
1968 }
1969 },
1970 {
1971 "docs": {
1972 "custom": {
1973 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-dynamic-threshold"
1974 },
1975 "stability": "external",
1976 "summary": "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."
1977 },
1978 "locationInModule": {
1979 "filename": "lib/cloudwatch.generated.ts",
1980 "line": 504
1981 },
1982 "name": "thresholdMetricId",
1983 "optional": true,
1984 "type": {
1985 "primitive": "string"
1986 }
1987 },
1988 {
1989 "docs": {
1990 "custom": {
1991 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-treatmissingdata"
1992 },
1993 "remarks": "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* .\n\nIf you omit this parameter, the default behavior of `missing` is used.",
1994 "stability": "external",
1995 "summary": "Sets how this alarm is to handle missing data points."
1996 },
1997 "locationInModule": {
1998 "filename": "lib/cloudwatch.generated.ts",
1999 "line": 513
2000 },
2001 "name": "treatMissingData",
2002 "optional": true,
2003 "type": {
2004 "primitive": "string"
2005 }
2006 },
2007 {
2008 "docs": {
2009 "custom": {
2010 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-unit"
2011 },
2012 "remarks": "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.\n\nYou 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.",
2013 "stability": "external",
2014 "summary": "The unit of the metric associated with the alarm."
2015 },
2016 "locationInModule": {
2017 "filename": "lib/cloudwatch.generated.ts",
2018 "line": 522
2019 },
2020 "name": "unit",
2021 "optional": true,
2022 "type": {
2023 "primitive": "string"
2024 }
2025 }
2026 ],
2027 "symbolId": "lib/cloudwatch.generated:CfnAlarm"
2028 },
2029 "@aws-cdk/aws-cloudwatch.CfnAlarm.DimensionProperty": {
2030 "assembly": "@aws-cdk/aws-cloudwatch",
2031 "datatype": true,
2032 "docs": {
2033 "custom": {
2034 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html",
2035 "exampleMetadata": "fixture=_generated"
2036 },
2037 "remarks": "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.",
2038 "stability": "external",
2039 "summary": "Dimension is an embedded property of the `AWS::CloudWatch::Alarm` type.",
2040 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst dimensionProperty: cloudwatch.CfnAlarm.DimensionProperty = {\n name: 'name',\n value: 'value',\n};"
2041 },
2042 "fqn": "@aws-cdk/aws-cloudwatch.CfnAlarm.DimensionProperty",
2043 "kind": "interface",
2044 "locationInModule": {
2045 "filename": "lib/cloudwatch.generated.ts",
2046 "line": 611
2047 },
2048 "name": "DimensionProperty",
2049 "namespace": "CfnAlarm",
2050 "properties": [
2051 {
2052 "abstract": true,
2053 "docs": {
2054 "custom": {
2055 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html#cfn-cloudwatch-alarm-dimension-name"
2056 },
2057 "remarks": "This dimension name must have been included when the metric was published.",
2058 "stability": "external",
2059 "summary": "The name of the dimension, from 1–255 characters in length."
2060 },
2061 "immutable": true,
2062 "locationInModule": {
2063 "filename": "lib/cloudwatch.generated.ts",
2064 "line": 617
2065 },
2066 "name": "name",
2067 "type": {
2068 "primitive": "string"
2069 }
2070 },
2071 {
2072 "abstract": true,
2073 "docs": {
2074 "custom": {
2075 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html#cfn-cloudwatch-alarm-dimension-value"
2076 },
2077 "stability": "external",
2078 "summary": "The value for the dimension, from 1–255 characters in length."
2079 },
2080 "immutable": true,
2081 "locationInModule": {
2082 "filename": "lib/cloudwatch.generated.ts",
2083 "line": 623
2084 },
2085 "name": "value",
2086 "type": {
2087 "primitive": "string"
2088 }
2089 }
2090 ],
2091 "symbolId": "lib/cloudwatch.generated:CfnAlarm.DimensionProperty"
2092 },
2093 "@aws-cdk/aws-cloudwatch.CfnAlarm.MetricDataQueryProperty": {
2094 "assembly": "@aws-cdk/aws-cloudwatch",
2095 "datatype": true,
2096 "docs": {
2097 "custom": {
2098 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html",
2099 "exampleMetadata": "fixture=_generated"
2100 },
2101 "remarks": "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* .",
2102 "stability": "external",
2103 "summary": "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.",
2104 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst metricDataQueryProperty: cloudwatch.CfnAlarm.MetricDataQueryProperty = {\n id: 'id',\n\n // the properties below are optional\n accountId: 'accountId',\n expression: 'expression',\n label: 'label',\n metricStat: {\n metric: {\n dimensions: [{\n name: 'name',\n value: 'value',\n }],\n metricName: 'metricName',\n namespace: 'namespace',\n },\n period: 123,\n stat: 'stat',\n\n // the properties below are optional\n unit: 'unit',\n },\n period: 123,\n returnData: false,\n};"
2105 },
2106 "fqn": "@aws-cdk/aws-cloudwatch.CfnAlarm.MetricDataQueryProperty",
2107 "kind": "interface",
2108 "locationInModule": {
2109 "filename": "lib/cloudwatch.generated.ts",
2110 "line": 776
2111 },
2112 "name": "MetricDataQueryProperty",
2113 "namespace": "CfnAlarm",
2114 "properties": [
2115 {
2116 "abstract": true,
2117 "docs": {
2118 "custom": {
2119 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-id"
2120 },
2121 "remarks": "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.",
2122 "stability": "external",
2123 "summary": "A short name used to tie this object to the results in the response."
2124 },
2125 "immutable": true,
2126 "locationInModule": {
2127 "filename": "lib/cloudwatch.generated.ts",
2128 "line": 796
2129 },
2130 "name": "id",
2131 "type": {
2132 "primitive": "string"
2133 }
2134 },
2135 {
2136 "abstract": true,
2137 "docs": {
2138 "custom": {
2139 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-accountid"
2140 },
2141 "stability": "external",
2142 "summary": "The ID of the account where the metrics are located, if this is a cross-account alarm."
2143 },
2144 "immutable": true,
2145 "locationInModule": {
2146 "filename": "lib/cloudwatch.generated.ts",
2147 "line": 782
2148 },
2149 "name": "accountId",
2150 "optional": true,
2151 "type": {
2152 "primitive": "string"
2153 }
2154 },
2155 {
2156 "abstract": true,
2157 "docs": {
2158 "custom": {
2159 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-expression"
2160 },
2161 "remarks": "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* .\n\nWithin each MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both.",
2162 "stability": "external",
2163 "summary": "The math expression to be performed on the returned data, if this object is performing a math expression."
2164 },
2165 "immutable": true,
2166 "locationInModule": {
2167 "filename": "lib/cloudwatch.generated.ts",
2168 "line": 790
2169 },
2170 "name": "expression",
2171 "optional": true,
2172 "type": {
2173 "primitive": "string"
2174 }
2175 },
2176 {
2177 "abstract": true,
2178 "docs": {
2179 "custom": {
2180 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-label"
2181 },
2182 "remarks": "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.",
2183 "stability": "external",
2184 "summary": "A human-readable label for this metric or expression."
2185 },
2186 "immutable": true,
2187 "locationInModule": {
2188 "filename": "lib/cloudwatch.generated.ts",
2189 "line": 802
2190 },
2191 "name": "label",
2192 "optional": true,
2193 "type": {
2194 "primitive": "string"
2195 }
2196 },
2197 {
2198 "abstract": true,
2199 "docs": {
2200 "custom": {
2201 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-metricstat"
2202 },
2203 "remarks": "Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.\n\nWithin one MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both.",
2204 "stability": "external",
2205 "summary": "The metric to be returned, along with statistics, period, and units."
2206 },
2207 "immutable": true,
2208 "locationInModule": {
2209 "filename": "lib/cloudwatch.generated.ts",
2210 "line": 810
2211 },
2212 "name": "metricStat",
2213 "optional": true,
2214 "type": {
2215 "union": {
2216 "types": [
2217 {
2218 "fqn": "@aws-cdk/core.IResolvable"
2219 },
2220 {
2221 "fqn": "@aws-cdk/aws-cloudwatch.CfnAlarm.MetricStatProperty"
2222 }
2223 ]
2224 }
2225 }
2226 },
2227 {
2228 "abstract": true,
2229 "docs": {
2230 "remarks": "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` .",
2231 "stability": "external",
2232 "summary": "The granularity, in seconds, of the returned data points."
2233 },
2234 "immutable": true,
2235 "locationInModule": {
2236 "filename": "lib/cloudwatch.generated.ts",
2237 "line": 814
2238 },
2239 "name": "period",
2240 "optional": true,
2241 "type": {
2242 "primitive": "number"
2243 }
2244 },
2245 {
2246 "abstract": true,
2247 "docs": {
2248 "custom": {
2249 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-returndata"
2250 },
2251 "remarks": "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.\n\nThis field is required.",
2252 "stability": "external",
2253 "summary": "This option indicates whether to return the timestamps and raw data values of this metric."
2254 },
2255 "immutable": true,
2256 "locationInModule": {
2257 "filename": "lib/cloudwatch.generated.ts",
2258 "line": 824
2259 },
2260 "name": "returnData",
2261 "optional": true,
2262 "type": {
2263 "union": {
2264 "types": [
2265 {
2266 "primitive": "boolean"
2267 },
2268 {
2269 "fqn": "@aws-cdk/core.IResolvable"
2270 }
2271 ]
2272 }
2273 }
2274 }
2275 ],
2276 "symbolId": "lib/cloudwatch.generated:CfnAlarm.MetricDataQueryProperty"
2277 },
2278 "@aws-cdk/aws-cloudwatch.CfnAlarm.MetricProperty": {
2279 "assembly": "@aws-cdk/aws-cloudwatch",
2280 "datatype": true,
2281 "docs": {
2282 "custom": {
2283 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html",
2284 "exampleMetadata": "fixture=_generated"
2285 },
2286 "remarks": "`Metric` is a property of the [MetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html) property type.",
2287 "stability": "external",
2288 "summary": "The `Metric` property type represents a specific metric.",
2289 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst metricProperty: cloudwatch.CfnAlarm.MetricProperty = {\n dimensions: [{\n name: 'name',\n value: 'value',\n }],\n metricName: 'metricName',\n namespace: 'namespace',\n};"
2290 },
2291 "fqn": "@aws-cdk/aws-cloudwatch.CfnAlarm.MetricProperty",
2292 "kind": "interface",
2293 "locationInModule": {
2294 "filename": "lib/cloudwatch.generated.ts",
2295 "line": 689
2296 },
2297 "name": "MetricProperty",
2298 "namespace": "CfnAlarm",
2299 "properties": [
2300 {
2301 "abstract": true,
2302 "docs": {
2303 "custom": {
2304 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html#cfn-cloudwatch-alarm-metric-dimensions"
2305 },
2306 "stability": "external",
2307 "summary": "The metric dimensions that you want to be used for the metric that the alarm will watch.."
2308 },
2309 "immutable": true,
2310 "locationInModule": {
2311 "filename": "lib/cloudwatch.generated.ts",
2312 "line": 695
2313 },
2314 "name": "dimensions",
2315 "optional": true,
2316 "type": {
2317 "union": {
2318 "types": [
2319 {
2320 "fqn": "@aws-cdk/core.IResolvable"
2321 },
2322 {
2323 "collection": {
2324 "elementtype": {
2325 "union": {
2326 "types": [
2327 {
2328 "fqn": "@aws-cdk/core.IResolvable"
2329 },
2330 {
2331 "fqn": "@aws-cdk/aws-cloudwatch.CfnAlarm.DimensionProperty"
2332 }
2333 ]
2334 }
2335 },
2336 "kind": "array"
2337 }
2338 }
2339 ]
2340 }
2341 }
2342 },
2343 {
2344 "abstract": true,
2345 "docs": {
2346 "custom": {
2347 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html#cfn-cloudwatch-alarm-metric-metricname"
2348 },
2349 "remarks": "This is a required field.",
2350 "stability": "external",
2351 "summary": "The name of the metric that you want the alarm to watch."
2352 },
2353 "immutable": true,
2354 "locationInModule": {
2355 "filename": "lib/cloudwatch.generated.ts",
2356 "line": 701
2357 },
2358 "name": "metricName",
2359 "optional": true,
2360 "type": {
2361 "primitive": "string"
2362 }
2363 },
2364 {
2365 "abstract": true,
2366 "docs": {
2367 "custom": {
2368 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html#cfn-cloudwatch-alarm-metric-namespace"
2369 },
2370 "stability": "external",
2371 "summary": "The namespace of the metric that the alarm will watch."
2372 },
2373 "immutable": true,
2374 "locationInModule": {
2375 "filename": "lib/cloudwatch.generated.ts",
2376 "line": 707
2377 },
2378 "name": "namespace",
2379 "optional": true,
2380 "type": {
2381 "primitive": "string"
2382 }
2383 }
2384 ],
2385 "symbolId": "lib/cloudwatch.generated:CfnAlarm.MetricProperty"
2386 },
2387 "@aws-cdk/aws-cloudwatch.CfnAlarm.MetricStatProperty": {
2388 "assembly": "@aws-cdk/aws-cloudwatch",
2389 "datatype": true,
2390 "docs": {
2391 "custom": {
2392 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html",
2393 "exampleMetadata": "fixture=_generated"
2394 },
2395 "remarks": "`MetricStat` is a property of the [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html) property type.",
2396 "stability": "external",
2397 "summary": "This structure defines the metric to be returned, along with the statistics, period, and units.",
2398 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst metricStatProperty: cloudwatch.CfnAlarm.MetricStatProperty = {\n metric: {\n dimensions: [{\n name: 'name',\n value: 'value',\n }],\n metricName: 'metricName',\n namespace: 'namespace',\n },\n period: 123,\n stat: 'stat',\n\n // the properties below are optional\n unit: 'unit',\n};"
2399 },
2400 "fqn": "@aws-cdk/aws-cloudwatch.CfnAlarm.MetricStatProperty",
2401 "kind": "interface",
2402 "locationInModule": {
2403 "filename": "lib/cloudwatch.generated.ts",
2404 "line": 906
2405 },
2406 "name": "MetricStatProperty",
2407 "namespace": "CfnAlarm",
2408 "properties": [
2409 {
2410 "abstract": true,
2411 "docs": {
2412 "custom": {
2413 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html#cfn-cloudwatch-alarm-metricstat-metric"
2414 },
2415 "stability": "external",
2416 "summary": "The metric to return, including the metric name, namespace, and dimensions."
2417 },
2418 "immutable": true,
2419 "locationInModule": {
2420 "filename": "lib/cloudwatch.generated.ts",
2421 "line": 912
2422 },
2423 "name": "metric",
2424 "type": {
2425 "union": {
2426 "types": [
2427 {
2428 "fqn": "@aws-cdk/core.IResolvable"
2429 },
2430 {
2431 "fqn": "@aws-cdk/aws-cloudwatch.CfnAlarm.MetricProperty"
2432 }
2433 ]
2434 }
2435 }
2436 },
2437 {
2438 "abstract": true,
2439 "docs": {
2440 "custom": {
2441 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html#cfn-cloudwatch-alarm-metricstat-period"
2442 },
2443 "remarks": "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.\n\nIf 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:\n\n- Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).\n- Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).\n- Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).",
2444 "stability": "external",
2445 "summary": "The granularity, in seconds, of the returned data points."
2446 },
2447 "immutable": true,
2448 "locationInModule": {
2449 "filename": "lib/cloudwatch.generated.ts",
2450 "line": 924
2451 },
2452 "name": "period",
2453 "type": {
2454 "primitive": "number"
2455 }
2456 },
2457 {
2458 "abstract": true,
2459 "docs": {
2460 "custom": {
2461 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html#cfn-cloudwatch-alarm-metricstat-stat"
2462 },
2463 "remarks": "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* .",
2464 "stability": "external",
2465 "summary": "The statistic to return."
2466 },
2467 "immutable": true,
2468 "locationInModule": {
2469 "filename": "lib/cloudwatch.generated.ts",
2470 "line": 930
2471 },
2472 "name": "stat",
2473 "type": {
2474 "primitive": "string"
2475 }
2476 },
2477 {
2478 "abstract": true,
2479 "docs": {
2480 "custom": {
2481 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html#cfn-cloudwatch-alarm-metricstat-unit"
2482 },
2483 "remarks": "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.",
2484 "stability": "external",
2485 "summary": "The unit to use for the returned data points."
2486 },
2487 "immutable": true,
2488 "locationInModule": {
2489 "filename": "lib/cloudwatch.generated.ts",
2490 "line": 938
2491 },
2492 "name": "unit",
2493 "optional": true,
2494 "type": {
2495 "primitive": "string"
2496 }
2497 }
2498 ],
2499 "symbolId": "lib/cloudwatch.generated:CfnAlarm.MetricStatProperty"
2500 },
2501 "@aws-cdk/aws-cloudwatch.CfnAlarmProps": {
2502 "assembly": "@aws-cdk/aws-cloudwatch",
2503 "datatype": true,
2504 "docs": {
2505 "custom": {
2506 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html",
2507 "exampleMetadata": "fixture=_generated"
2508 },
2509 "stability": "external",
2510 "summary": "Properties for defining a `CfnAlarm`.",
2511 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst cfnAlarmProps: cloudwatch.CfnAlarmProps = {\n comparisonOperator: 'comparisonOperator',\n evaluationPeriods: 123,\n\n // the properties below are optional\n actionsEnabled: false,\n alarmActions: ['alarmActions'],\n alarmDescription: 'alarmDescription',\n alarmName: 'alarmName',\n datapointsToAlarm: 123,\n dimensions: [{\n name: 'name',\n value: 'value',\n }],\n evaluateLowSampleCountPercentile: 'evaluateLowSampleCountPercentile',\n extendedStatistic: 'extendedStatistic',\n insufficientDataActions: ['insufficientDataActions'],\n metricName: 'metricName',\n metrics: [{\n id: 'id',\n\n // the properties below are optional\n accountId: 'accountId',\n expression: 'expression',\n label: 'label',\n metricStat: {\n metric: {\n dimensions: [{\n name: 'name',\n value: 'value',\n }],\n metricName: 'metricName',\n namespace: 'namespace',\n },\n period: 123,\n stat: 'stat',\n\n // the properties below are optional\n unit: 'unit',\n },\n period: 123,\n returnData: false,\n }],\n namespace: 'namespace',\n okActions: ['okActions'],\n period: 123,\n statistic: 'statistic',\n threshold: 123,\n thresholdMetricId: 'thresholdMetricId',\n treatMissingData: 'treatMissingData',\n unit: 'unit',\n};"
2512 },
2513 "fqn": "@aws-cdk/aws-cloudwatch.CfnAlarmProps",
2514 "kind": "interface",
2515 "locationInModule": {
2516 "filename": "lib/cloudwatch.generated.ts",
2517 "line": 19
2518 },
2519 "name": "CfnAlarmProps",
2520 "properties": [
2521 {
2522 "abstract": true,
2523 "docs": {
2524 "custom": {
2525 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-comparisonoperator"
2526 },
2527 "remarks": "The specified statistic value is used as the first operand.\n\nYou can specify the following values: `GreaterThanThreshold` , `GreaterThanOrEqualToThreshold` , `LessThanThreshold` , or `LessThanOrEqualToThreshold` .",
2528 "stability": "external",
2529 "summary": "The arithmetic operation to use when comparing the specified statistic and threshold."
2530 },
2531 "immutable": true,
2532 "locationInModule": {
2533 "filename": "lib/cloudwatch.generated.ts",
2534 "line": 28
2535 },
2536 "name": "comparisonOperator",
2537 "type": {
2538 "primitive": "string"
2539 }
2540 },
2541 {
2542 "abstract": true,
2543 "docs": {
2544 "custom": {
2545 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-evaluationperiods"
2546 },
2547 "remarks": "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.\n\nFor more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *Amazon CloudWatch User Guide* .",
2548 "stability": "external",
2549 "summary": "The number of periods over which data is compared to the specified threshold."
2550 },
2551 "immutable": true,
2552 "locationInModule": {
2553 "filename": "lib/cloudwatch.generated.ts",
2554 "line": 37
2555 },
2556 "name": "evaluationPeriods",
2557 "type": {
2558 "primitive": "number"
2559 }
2560 },
2561 {
2562 "abstract": true,
2563 "docs": {
2564 "custom": {
2565 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-actionsenabled"
2566 },
2567 "remarks": "The default is TRUE.",
2568 "stability": "external",
2569 "summary": "Indicates whether actions should be executed during any changes to the alarm state."
2570 },
2571 "immutable": true,
2572 "locationInModule": {
2573 "filename": "lib/cloudwatch.generated.ts",
2574 "line": 44
2575 },
2576 "name": "actionsEnabled",
2577 "optional": true,
2578 "type": {
2579 "union": {
2580 "types": [
2581 {
2582 "primitive": "boolean"
2583 },
2584 {
2585 "fqn": "@aws-cdk/core.IResolvable"
2586 }
2587 ]
2588 }
2589 }
2590 },
2591 {
2592 "abstract": true,
2593 "docs": {
2594 "custom": {
2595 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmactions"
2596 },
2597 "remarks": "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* .",
2598 "stability": "external",
2599 "summary": "The list of actions to execute when this alarm transitions into an ALARM state from any other state."
2600 },
2601 "immutable": true,
2602 "locationInModule": {
2603 "filename": "lib/cloudwatch.generated.ts",
2604 "line": 51
2605 },
2606 "name": "alarmActions",
2607 "optional": true,
2608 "type": {
2609 "collection": {
2610 "elementtype": {
2611 "primitive": "string"
2612 },
2613 "kind": "array"
2614 }
2615 }
2616 },
2617 {
2618 "abstract": true,
2619 "docs": {
2620 "custom": {
2621 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmdescription"
2622 },
2623 "stability": "external",
2624 "summary": "The description of the alarm."
2625 },
2626 "immutable": true,
2627 "locationInModule": {
2628 "filename": "lib/cloudwatch.generated.ts",
2629 "line": 58
2630 },
2631 "name": "alarmDescription",
2632 "optional": true,
2633 "type": {
2634 "primitive": "string"
2635 }
2636 },
2637 {
2638 "abstract": true,
2639 "docs": {
2640 "custom": {
2641 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmname"
2642 },
2643 "remarks": "If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the alarm name.\n\n> 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.",
2644 "stability": "external",
2645 "summary": "The name of the alarm."
2646 },
2647 "immutable": true,
2648 "locationInModule": {
2649 "filename": "lib/cloudwatch.generated.ts",
2650 "line": 67
2651 },
2652 "name": "alarmName",
2653 "optional": true,
2654 "type": {
2655 "primitive": "string"
2656 }
2657 },
2658 {
2659 "abstract": true,
2660 "docs": {
2661 "custom": {
2662 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarm-datapointstoalarm"
2663 },
2664 "remarks": "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* .\n\nIf 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.",
2665 "stability": "external",
2666 "summary": "The number of datapoints that must be breaching to trigger the alarm."
2667 },
2668 "immutable": true,
2669 "locationInModule": {
2670 "filename": "lib/cloudwatch.generated.ts",
2671 "line": 76
2672 },
2673 "name": "datapointsToAlarm",
2674 "optional": true,
2675 "type": {
2676 "primitive": "number"
2677 }
2678 },
2679 {
2680 "abstract": true,
2681 "docs": {
2682 "custom": {
2683 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-dimension"
2684 },
2685 "remarks": "For an alarm based on a math expression, you can't specify `Dimensions` . Instead, you use `Metrics` .",
2686 "stability": "external",
2687 "summary": "The dimensions for the metric associated with the alarm."
2688 },
2689 "immutable": true,
2690 "locationInModule": {
2691 "filename": "lib/cloudwatch.generated.ts",
2692 "line": 83
2693 },
2694 "name": "dimensions",
2695 "optional": true,
2696 "type": {
2697 "union": {
2698 "types": [
2699 {
2700 "fqn": "@aws-cdk/core.IResolvable"
2701 },
2702 {
2703 "collection": {
2704 "elementtype": {
2705 "union": {
2706 "types": [
2707 {
2708 "fqn": "@aws-cdk/core.IResolvable"
2709 },
2710 {
2711 "fqn": "@aws-cdk/aws-cloudwatch.CfnAlarm.DimensionProperty"
2712 }
2713 ]
2714 }
2715 },
2716 "kind": "array"
2717 }
2718 }
2719 ]
2720 }
2721 }
2722 },
2723 {
2724 "abstract": true,
2725 "docs": {
2726 "custom": {
2727 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-evaluatelowsamplecountpercentile"
2728 },
2729 "remarks": "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.",
2730 "stability": "external",
2731 "summary": "Used only for alarms based on percentiles."
2732 },
2733 "immutable": true,
2734 "locationInModule": {
2735 "filename": "lib/cloudwatch.generated.ts",
2736 "line": 90
2737 },
2738 "name": "evaluateLowSampleCountPercentile",
2739 "optional": true,
2740 "type": {
2741 "primitive": "string"
2742 }
2743 },
2744 {
2745 "abstract": true,
2746 "docs": {
2747 "custom": {
2748 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-extendedstatistic"
2749 },
2750 "remarks": "For an alarm based on a metric, you must specify either `Statistic` or `ExtendedStatistic` but not both.\n\nFor an alarm based on a math expression, you can't specify `ExtendedStatistic` . Instead, you use `Metrics` .",
2751 "stability": "external",
2752 "summary": "The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100."
2753 },
2754 "immutable": true,
2755 "locationInModule": {
2756 "filename": "lib/cloudwatch.generated.ts",
2757 "line": 101
2758 },
2759 "name": "extendedStatistic",
2760 "optional": true,
2761 "type": {
2762 "primitive": "string"
2763 }
2764 },
2765 {
2766 "abstract": true,
2767 "docs": {
2768 "custom": {
2769 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-insufficientdataactions"
2770 },
2771 "remarks": "Each action is specified as an Amazon Resource Name (ARN).",
2772 "stability": "external",
2773 "summary": "The actions to execute when this alarm transitions to the `INSUFFICIENT_DATA` state from any other state."
2774 },
2775 "immutable": true,
2776 "locationInModule": {
2777 "filename": "lib/cloudwatch.generated.ts",
2778 "line": 108
2779 },
2780 "name": "insufficientDataActions",
2781 "optional": true,
2782 "type": {
2783 "collection": {
2784 "elementtype": {
2785 "primitive": "string"
2786 },
2787 "kind": "array"
2788 }
2789 }
2790 },
2791 {
2792 "abstract": true,
2793 "docs": {
2794 "custom": {
2795 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-metricname"
2796 },
2797 "remarks": "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` .",
2798 "stability": "external",
2799 "summary": "The name of the metric associated with the alarm."
2800 },
2801 "immutable": true,
2802 "locationInModule": {
2803 "filename": "lib/cloudwatch.generated.ts",
2804 "line": 115
2805 },
2806 "name": "metricName",
2807 "optional": true,
2808 "type": {
2809 "primitive": "string"
2810 }
2811 },
2812 {
2813 "abstract": true,
2814 "docs": {
2815 "custom": {
2816 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarm-metrics"
2817 },
2818 "remarks": "Each item in the array either retrieves a metric or performs a math expression.\n\nIf you specify the `Metrics` parameter, you cannot specify `MetricName` , `Dimensions` , `Period` , `Namespace` , `Statistic` , `ExtendedStatistic` , or `Unit` .",
2819 "stability": "external",
2820 "summary": "An array that enables you to create an alarm based on the result of a metric math expression."
2821 },
2822 "immutable": true,
2823 "locationInModule": {
2824 "filename": "lib/cloudwatch.generated.ts",
2825 "line": 124
2826 },
2827 "name": "metrics",
2828 "optional": true,
2829 "type": {
2830 "union": {
2831 "types": [
2832 {
2833 "fqn": "@aws-cdk/core.IResolvable"
2834 },
2835 {
2836 "collection": {
2837 "elementtype": {
2838 "union": {
2839 "types": [
2840 {
2841 "fqn": "@aws-cdk/core.IResolvable"
2842 },
2843 {
2844 "fqn": "@aws-cdk/aws-cloudwatch.CfnAlarm.MetricDataQueryProperty"
2845 }
2846 ]
2847 }
2848 },
2849 "kind": "array"
2850 }
2851 }
2852 ]
2853 }
2854 }
2855 },
2856 {
2857 "abstract": true,
2858 "docs": {
2859 "custom": {
2860 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-namespace"
2861 },
2862 "remarks": "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.\n\nFor 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)",
2863 "stability": "external",
2864 "summary": "The namespace of the metric associated with the alarm."
2865 },
2866 "immutable": true,
2867 "locationInModule": {
2868 "filename": "lib/cloudwatch.generated.ts",
2869 "line": 133
2870 },
2871 "name": "namespace",
2872 "optional": true,
2873 "type": {
2874 "primitive": "string"
2875 }
2876 },
2877 {
2878 "abstract": true,
2879 "docs": {
2880 "custom": {
2881 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-okactions"
2882 },
2883 "remarks": "Each action is specified as an Amazon Resource Name (ARN).",
2884 "stability": "external",
2885 "summary": "The actions to execute when this alarm transitions to the `OK` state from any other state."
2886 },
2887 "immutable": true,
2888 "locationInModule": {
2889 "filename": "lib/cloudwatch.generated.ts",
2890 "line": 140
2891 },
2892 "name": "okActions",
2893 "optional": true,
2894 "type": {
2895 "collection": {
2896 "elementtype": {
2897 "primitive": "string"
2898 },
2899 "kind": "array"
2900 }
2901 }
2902 },
2903 {
2904 "abstract": true,
2905 "docs": {
2906 "custom": {
2907 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-period"
2908 },
2909 "remarks": "This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.\n\nFor an alarm based on a math expression, you can't specify `Period` , and instead you use the `Metrics` parameter.\n\n*Minimum:* 10",
2910 "stability": "external",
2911 "summary": "The period, in seconds, over which the statistic is applied."
2912 },
2913 "immutable": true,
2914 "locationInModule": {
2915 "filename": "lib/cloudwatch.generated.ts",
2916 "line": 151
2917 },
2918 "name": "period",
2919 "optional": true,
2920 "type": {
2921 "primitive": "number"
2922 }
2923 },
2924 {
2925 "abstract": true,
2926 "docs": {
2927 "custom": {
2928 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-statistic"
2929 },
2930 "remarks": "For an alarm based on a metric, you must specify either `Statistic` or `ExtendedStatistic` but not both.\n\nFor an alarm based on a math expression, you can't specify `Statistic` . Instead, you use `Metrics` .",
2931 "stability": "external",
2932 "summary": "The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use `ExtendedStatistic` ."
2933 },
2934 "immutable": true,
2935 "locationInModule": {
2936 "filename": "lib/cloudwatch.generated.ts",
2937 "line": 162
2938 },
2939 "name": "statistic",
2940 "optional": true,
2941 "type": {
2942 "primitive": "string"
2943 }
2944 },
2945 {
2946 "abstract": true,
2947 "docs": {
2948 "custom": {
2949 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-threshold"
2950 },
2951 "stability": "external",
2952 "summary": "The value to compare with the specified statistic."
2953 },
2954 "immutable": true,
2955 "locationInModule": {
2956 "filename": "lib/cloudwatch.generated.ts",
2957 "line": 169
2958 },
2959 "name": "threshold",
2960 "optional": true,
2961 "type": {
2962 "primitive": "number"
2963 }
2964 },
2965 {
2966 "abstract": true,
2967 "docs": {
2968 "custom": {
2969 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-dynamic-threshold"
2970 },
2971 "stability": "external",
2972 "summary": "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."
2973 },
2974 "immutable": true,
2975 "locationInModule": {
2976 "filename": "lib/cloudwatch.generated.ts",
2977 "line": 176
2978 },
2979 "name": "thresholdMetricId",
2980 "optional": true,
2981 "type": {
2982 "primitive": "string"
2983 }
2984 },
2985 {
2986 "abstract": true,
2987 "docs": {
2988 "custom": {
2989 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-treatmissingdata"
2990 },
2991 "remarks": "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* .\n\nIf you omit this parameter, the default behavior of `missing` is used.",
2992 "stability": "external",
2993 "summary": "Sets how this alarm is to handle missing data points."
2994 },
2995 "immutable": true,
2996 "locationInModule": {
2997 "filename": "lib/cloudwatch.generated.ts",
2998 "line": 185
2999 },
3000 "name": "treatMissingData",
3001 "optional": true,
3002 "type": {
3003 "primitive": "string"
3004 }
3005 },
3006 {
3007 "abstract": true,
3008 "docs": {
3009 "custom": {
3010 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-unit"
3011 },
3012 "remarks": "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.\n\nYou 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.",
3013 "stability": "external",
3014 "summary": "The unit of the metric associated with the alarm."
3015 },
3016 "immutable": true,
3017 "locationInModule": {
3018 "filename": "lib/cloudwatch.generated.ts",
3019 "line": 194
3020 },
3021 "name": "unit",
3022 "optional": true,
3023 "type": {
3024 "primitive": "string"
3025 }
3026 }
3027 ],
3028 "symbolId": "lib/cloudwatch.generated:CfnAlarmProps"
3029 },
3030 "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector": {
3031 "assembly": "@aws-cdk/aws-cloudwatch",
3032 "base": "@aws-cdk/core.CfnResource",
3033 "docs": {
3034 "custom": {
3035 "cloudformationResource": "AWS::CloudWatch::AnomalyDetector",
3036 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html",
3037 "exampleMetadata": "fixture=_generated"
3038 },
3039 "remarks": "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.",
3040 "stability": "external",
3041 "summary": "A CloudFormation `AWS::CloudWatch::AnomalyDetector`.",
3042 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst cfnAnomalyDetector = new cloudwatch.CfnAnomalyDetector(this, 'MyCfnAnomalyDetector', /* all optional props */ {\n configuration: {\n excludedTimeRanges: [{\n endTime: 'endTime',\n startTime: 'startTime',\n }],\n metricTimeZone: 'metricTimeZone',\n },\n dimensions: [{\n name: 'name',\n value: 'value',\n }],\n metricMathAnomalyDetector: {\n metricDataQueries: [{\n id: 'id',\n\n // the properties below are optional\n accountId: 'accountId',\n expression: 'expression',\n label: 'label',\n metricStat: {\n metric: {\n metricName: 'metricName',\n namespace: 'namespace',\n\n // the properties below are optional\n dimensions: [{\n name: 'name',\n value: 'value',\n }],\n },\n period: 123,\n stat: 'stat',\n\n // the properties below are optional\n unit: 'unit',\n },\n period: 123,\n returnData: false,\n }],\n },\n metricName: 'metricName',\n namespace: 'namespace',\n singleMetricAnomalyDetector: {\n dimensions: [{\n name: 'name',\n value: 'value',\n }],\n metricName: 'metricName',\n namespace: 'namespace',\n stat: 'stat',\n },\n stat: 'stat',\n});"
3043 },
3044 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector",
3045 "initializer": {
3046 "docs": {
3047 "stability": "external",
3048 "summary": "Create a new `AWS::CloudWatch::AnomalyDetector`."
3049 },
3050 "locationInModule": {
3051 "filename": "lib/cloudwatch.generated.ts",
3052 "line": 1216
3053 },
3054 "parameters": [
3055 {
3056 "docs": {
3057 "summary": "- scope in which this resource is defined."
3058 },
3059 "name": "scope",
3060 "type": {
3061 "fqn": "@aws-cdk/core.Construct"
3062 }
3063 },
3064 {
3065 "docs": {
3066 "summary": "- scoped id of the resource."
3067 },
3068 "name": "id",
3069 "type": {
3070 "primitive": "string"
3071 }
3072 },
3073 {
3074 "docs": {
3075 "summary": "- resource properties."
3076 },
3077 "name": "props",
3078 "optional": true,
3079 "type": {
3080 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetectorProps"
3081 }
3082 }
3083 ]
3084 },
3085 "interfaces": [
3086 "@aws-cdk/core.IInspectable"
3087 ],
3088 "kind": "class",
3089 "locationInModule": {
3090 "filename": "lib/cloudwatch.generated.ts",
3091 "line": 1135
3092 },
3093 "methods": [
3094 {
3095 "docs": {
3096 "stability": "external",
3097 "summary": "Examines the CloudFormation resource and discloses attributes."
3098 },
3099 "locationInModule": {
3100 "filename": "lib/cloudwatch.generated.ts",
3101 "line": 1234
3102 },
3103 "name": "inspect",
3104 "overrides": "@aws-cdk/core.IInspectable",
3105 "parameters": [
3106 {
3107 "docs": {
3108 "summary": "- tree inspector to collect and process attributes."
3109 },
3110 "name": "inspector",
3111 "type": {
3112 "fqn": "@aws-cdk/core.TreeInspector"
3113 }
3114 }
3115 ]
3116 },
3117 {
3118 "docs": {
3119 "stability": "external"
3120 },
3121 "locationInModule": {
3122 "filename": "lib/cloudwatch.generated.ts",
3123 "line": 1251
3124 },
3125 "name": "renderProperties",
3126 "overrides": "@aws-cdk/core.CfnResource",
3127 "parameters": [
3128 {
3129 "name": "props",
3130 "type": {
3131 "collection": {
3132 "elementtype": {
3133 "primitive": "any"
3134 },
3135 "kind": "map"
3136 }
3137 }
3138 }
3139 ],
3140 "protected": true,
3141 "returns": {
3142 "type": {
3143 "collection": {
3144 "elementtype": {
3145 "primitive": "any"
3146 },
3147 "kind": "map"
3148 }
3149 }
3150 }
3151 }
3152 ],
3153 "name": "CfnAnomalyDetector",
3154 "properties": [
3155 {
3156 "const": true,
3157 "docs": {
3158 "stability": "external",
3159 "summary": "The CloudFormation resource type name for this resource class."
3160 },
3161 "immutable": true,
3162 "locationInModule": {
3163 "filename": "lib/cloudwatch.generated.ts",
3164 "line": 1139
3165 },
3166 "name": "CFN_RESOURCE_TYPE_NAME",
3167 "static": true,
3168 "type": {
3169 "primitive": "string"
3170 }
3171 },
3172 {
3173 "docs": {
3174 "stability": "external"
3175 },
3176 "immutable": true,
3177 "locationInModule": {
3178 "filename": "lib/cloudwatch.generated.ts",
3179 "line": 1239
3180 },
3181 "name": "cfnProperties",
3182 "overrides": "@aws-cdk/core.CfnResource",
3183 "protected": true,
3184 "type": {
3185 "collection": {
3186 "elementtype": {
3187 "primitive": "any"
3188 },
3189 "kind": "map"
3190 }
3191 }
3192 },
3193 {
3194 "docs": {
3195 "custom": {
3196 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-configuration"
3197 },
3198 "remarks": "The configuration can also include the time zone to use for the metric.",
3199 "stability": "external",
3200 "summary": "Specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model."
3201 },
3202 "locationInModule": {
3203 "filename": "lib/cloudwatch.generated.ts",
3204 "line": 1165
3205 },
3206 "name": "configuration",
3207 "optional": true,
3208 "type": {
3209 "union": {
3210 "types": [
3211 {
3212 "fqn": "@aws-cdk/core.IResolvable"
3213 },
3214 {
3215 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.ConfigurationProperty"
3216 }
3217 ]
3218 }
3219 }
3220 },
3221 {
3222 "docs": {
3223 "custom": {
3224 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-dimensions"
3225 },
3226 "stability": "external",
3227 "summary": "The dimensions of the metric associated with the anomaly detection band."
3228 },
3229 "locationInModule": {
3230 "filename": "lib/cloudwatch.generated.ts",
3231 "line": 1172
3232 },
3233 "name": "dimensions",
3234 "optional": true,
3235 "type": {
3236 "union": {
3237 "types": [
3238 {
3239 "fqn": "@aws-cdk/core.IResolvable"
3240 },
3241 {
3242 "collection": {
3243 "elementtype": {
3244 "union": {
3245 "types": [
3246 {
3247 "fqn": "@aws-cdk/core.IResolvable"
3248 },
3249 {
3250 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.DimensionProperty"
3251 }
3252 ]
3253 }
3254 },
3255 "kind": "array"
3256 }
3257 }
3258 ]
3259 }
3260 }
3261 },
3262 {
3263 "docs": {
3264 "custom": {
3265 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-metricmathanomalydetector"
3266 },
3267 "stability": "external",
3268 "summary": "The CloudWatch metric math expression for this anomaly detector."
3269 },
3270 "locationInModule": {
3271 "filename": "lib/cloudwatch.generated.ts",
3272 "line": 1179
3273 },
3274 "name": "metricMathAnomalyDetector",
3275 "optional": true,
3276 "type": {
3277 "union": {
3278 "types": [
3279 {
3280 "fqn": "@aws-cdk/core.IResolvable"
3281 },
3282 {
3283 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.MetricMathAnomalyDetectorProperty"
3284 }
3285 ]
3286 }
3287 }
3288 },
3289 {
3290 "docs": {
3291 "custom": {
3292 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-metricname"
3293 },
3294 "stability": "external",
3295 "summary": "The name of the metric associated with the anomaly detection band."
3296 },
3297 "locationInModule": {
3298 "filename": "lib/cloudwatch.generated.ts",
3299 "line": 1186
3300 },
3301 "name": "metricName",
3302 "optional": true,
3303 "type": {
3304 "primitive": "string"
3305 }
3306 },
3307 {
3308 "docs": {
3309 "custom": {
3310 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-namespace"
3311 },
3312 "stability": "external",
3313 "summary": "The namespace of the metric associated with the anomaly detection band."
3314 },
3315 "locationInModule": {
3316 "filename": "lib/cloudwatch.generated.ts",
3317 "line": 1193
3318 },
3319 "name": "namespace",
3320 "optional": true,
3321 "type": {
3322 "primitive": "string"
3323 }
3324 },
3325 {
3326 "docs": {
3327 "custom": {
3328 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-singlemetricanomalydetector"
3329 },
3330 "stability": "external",
3331 "summary": "The CloudWatch metric and statistic for this anomaly detector."
3332 },
3333 "locationInModule": {
3334 "filename": "lib/cloudwatch.generated.ts",
3335 "line": 1200
3336 },
3337 "name": "singleMetricAnomalyDetector",
3338 "optional": true,
3339 "type": {
3340 "union": {
3341 "types": [
3342 {
3343 "fqn": "@aws-cdk/core.IResolvable"
3344 },
3345 {
3346 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.SingleMetricAnomalyDetectorProperty"
3347 }
3348 ]
3349 }
3350 }
3351 },
3352 {
3353 "docs": {
3354 "custom": {
3355 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-stat"
3356 },
3357 "stability": "external",
3358 "summary": "The statistic of the metric associated with the anomaly detection band."
3359 },
3360 "locationInModule": {
3361 "filename": "lib/cloudwatch.generated.ts",
3362 "line": 1207
3363 },
3364 "name": "stat",
3365 "optional": true,
3366 "type": {
3367 "primitive": "string"
3368 }
3369 }
3370 ],
3371 "symbolId": "lib/cloudwatch.generated:CfnAnomalyDetector"
3372 },
3373 "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.ConfigurationProperty": {
3374 "assembly": "@aws-cdk/aws-cloudwatch",
3375 "datatype": true,
3376 "docs": {
3377 "custom": {
3378 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-configuration.html",
3379 "exampleMetadata": "fixture=_generated"
3380 },
3381 "remarks": "The configuration can also include the time zone to use for the metric.",
3382 "stability": "external",
3383 "summary": "Specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model.",
3384 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst configurationProperty: cloudwatch.CfnAnomalyDetector.ConfigurationProperty = {\n excludedTimeRanges: [{\n endTime: 'endTime',\n startTime: 'startTime',\n }],\n metricTimeZone: 'metricTimeZone',\n};"
3385 },
3386 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.ConfigurationProperty",
3387 "kind": "interface",
3388 "locationInModule": {
3389 "filename": "lib/cloudwatch.generated.ts",
3390 "line": 1265
3391 },
3392 "name": "ConfigurationProperty",
3393 "namespace": "CfnAnomalyDetector",
3394 "properties": [
3395 {
3396 "abstract": true,
3397 "docs": {
3398 "custom": {
3399 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-configuration.html#cfn-cloudwatch-anomalydetector-configuration-excludedtimeranges"
3400 },
3401 "remarks": "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.",
3402 "stability": "external",
3403 "summary": "Specifies an array of time ranges to exclude from use when the anomaly detection model is trained and updated."
3404 },
3405 "immutable": true,
3406 "locationInModule": {
3407 "filename": "lib/cloudwatch.generated.ts",
3408 "line": 1271
3409 },
3410 "name": "excludedTimeRanges",
3411 "optional": true,
3412 "type": {
3413 "union": {
3414 "types": [
3415 {
3416 "fqn": "@aws-cdk/core.IResolvable"
3417 },
3418 {
3419 "collection": {
3420 "elementtype": {
3421 "union": {
3422 "types": [
3423 {
3424 "fqn": "@aws-cdk/core.IResolvable"
3425 },
3426 {
3427 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.RangeProperty"
3428 }
3429 ]
3430 }
3431 },
3432 "kind": "array"
3433 }
3434 }
3435 ]
3436 }
3437 }
3438 },
3439 {
3440 "abstract": true,
3441 "docs": {
3442 "custom": {
3443 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-configuration.html#cfn-cloudwatch-anomalydetector-configuration-metrictimezone"
3444 },
3445 "remarks": "This is useful to enable the model to automatically account for daylight savings time changes if the metric is sensitive to such time changes.\n\nTo 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) .",
3446 "stability": "external",
3447 "summary": "The time zone to use for the metric."
3448 },
3449 "immutable": true,
3450 "locationInModule": {
3451 "filename": "lib/cloudwatch.generated.ts",
3452 "line": 1279
3453 },
3454 "name": "metricTimeZone",
3455 "optional": true,
3456 "type": {
3457 "primitive": "string"
3458 }
3459 }
3460 ],
3461 "symbolId": "lib/cloudwatch.generated:CfnAnomalyDetector.ConfigurationProperty"
3462 },
3463 "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.DimensionProperty": {
3464 "assembly": "@aws-cdk/aws-cloudwatch",
3465 "datatype": true,
3466 "docs": {
3467 "custom": {
3468 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html",
3469 "exampleMetadata": "fixture=_generated"
3470 },
3471 "remarks": "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.\n\nYou can assign up to 10 dimensions to a metric.",
3472 "stability": "external",
3473 "summary": "A dimension is a name/value pair that is part of the identity of a metric.",
3474 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst dimensionProperty: cloudwatch.CfnAnomalyDetector.DimensionProperty = {\n name: 'name',\n value: 'value',\n};"
3475 },
3476 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.DimensionProperty",
3477 "kind": "interface",
3478 "locationInModule": {
3479 "filename": "lib/cloudwatch.generated.ts",
3480 "line": 1345
3481 },
3482 "name": "DimensionProperty",
3483 "namespace": "CfnAnomalyDetector",
3484 "properties": [
3485 {
3486 "abstract": true,
3487 "docs": {
3488 "custom": {
3489 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html#cfn-cloudwatch-anomalydetector-dimension-name"
3490 },
3491 "stability": "external",
3492 "summary": "The name of the dimension."
3493 },
3494 "immutable": true,
3495 "locationInModule": {
3496 "filename": "lib/cloudwatch.generated.ts",
3497 "line": 1351
3498 },
3499 "name": "name",
3500 "type": {
3501 "primitive": "string"
3502 }
3503 },
3504 {
3505 "abstract": true,
3506 "docs": {
3507 "custom": {
3508 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html#cfn-cloudwatch-anomalydetector-dimension-value"
3509 },
3510 "remarks": "Dimension values must contain only ASCII characters and must include at least one non-whitespace character.",
3511 "stability": "external",
3512 "summary": "The value of the dimension."
3513 },
3514 "immutable": true,
3515 "locationInModule": {
3516 "filename": "lib/cloudwatch.generated.ts",
3517 "line": 1357
3518 },
3519 "name": "value",
3520 "type": {
3521 "primitive": "string"
3522 }
3523 }
3524 ],
3525 "symbolId": "lib/cloudwatch.generated:CfnAnomalyDetector.DimensionProperty"
3526 },
3527 "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.MetricDataQueryProperty": {
3528 "assembly": "@aws-cdk/aws-cloudwatch",
3529 "datatype": true,
3530 "docs": {
3531 "custom": {
3532 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html",
3533 "exampleMetadata": "fixture=_generated"
3534 },
3535 "remarks": "The supported use of this structure is different for those two operations.\n\nWhen 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.\n\nWhen 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.\n\nAny 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* .\n\nSome 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.",
3536 "stability": "external",
3537 "summary": "This structure is used in both `GetMetricData` and `PutMetricAlarm` .",
3538 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst metricDataQueryProperty: cloudwatch.CfnAnomalyDetector.MetricDataQueryProperty = {\n id: 'id',\n\n // the properties below are optional\n accountId: 'accountId',\n expression: 'expression',\n label: 'label',\n metricStat: {\n metric: {\n metricName: 'metricName',\n namespace: 'namespace',\n\n // the properties below are optional\n dimensions: [{\n name: 'name',\n value: 'value',\n }],\n },\n period: 123,\n stat: 'stat',\n\n // the properties below are optional\n unit: 'unit',\n },\n period: 123,\n returnData: false,\n};"
3539 },
3540 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.MetricDataQueryProperty",
3541 "kind": "interface",
3542 "locationInModule": {
3543 "filename": "lib/cloudwatch.generated.ts",
3544 "line": 1518
3545 },
3546 "name": "MetricDataQueryProperty",
3547 "namespace": "CfnAnomalyDetector",
3548 "properties": [
3549 {
3550 "abstract": true,
3551 "docs": {
3552 "custom": {
3553 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html#cfn-cloudwatch-anomalydetector-metricdataquery-id"
3554 },
3555 "remarks": "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.",
3556 "stability": "external",
3557 "summary": "A short name used to tie this object to the results in the response."
3558 },
3559 "immutable": true,
3560 "locationInModule": {
3561 "filename": "lib/cloudwatch.generated.ts",
3562 "line": 1542
3563 },
3564 "name": "id",
3565 "type": {
3566 "primitive": "string"
3567 }
3568 },
3569 {
3570 "abstract": true,
3571 "docs": {
3572 "custom": {
3573 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html#cfn-cloudwatch-anomalydetector-metricdataquery-accountid"
3574 },
3575 "remarks": "Use this field only for `PutMetricAlarm` operations. It is not used in `GetMetricData` operations.",
3576 "stability": "external",
3577 "summary": "The ID of the account where the metrics are located, if this is a cross-account alarm."
3578 },
3579 "immutable": true,
3580 "locationInModule": {
3581 "filename": "lib/cloudwatch.generated.ts",
3582 "line": 1526
3583 },
3584 "name": "accountId",
3585 "optional": true,
3586 "type": {
3587 "primitive": "string"
3588 }
3589 },
3590 {
3591 "abstract": true,
3592 "docs": {
3593 "custom": {
3594 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html#cfn-cloudwatch-anomalydetector-metricdataquery-expression"
3595 },
3596 "remarks": "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* .\n\nA 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* .\n\nWithin each MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both.",
3597 "stability": "external",
3598 "summary": "This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data."
3599 },
3600 "immutable": true,
3601 "locationInModule": {
3602 "filename": "lib/cloudwatch.generated.ts",
3603 "line": 1536
3604 },
3605 "name": "expression",
3606 "optional": true,
3607 "type": {
3608 "primitive": "string"
3609 }
3610 },
3611 {
3612 "abstract": true,
3613 "docs": {
3614 "custom": {
3615 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html#cfn-cloudwatch-anomalydetector-metricdataquery-label"
3616 },
3617 "remarks": "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.\n\nYou 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) .",
3618 "stability": "external",
3619 "summary": "A human-readable label for this metric or expression."
3620 },
3621 "immutable": true,
3622 "locationInModule": {
3623 "filename": "lib/cloudwatch.generated.ts",
3624 "line": 1550
3625 },
3626 "name": "label",
3627 "optional": true,
3628 "type": {
3629 "primitive": "string"
3630 }
3631 },
3632 {
3633 "abstract": true,
3634 "docs": {
3635 "custom": {
3636 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html#cfn-cloudwatch-anomalydetector-metricdataquery-metricstat"
3637 },
3638 "remarks": "Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.\n\nWithin one MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both.",
3639 "stability": "external",
3640 "summary": "The metric to be returned, along with statistics, period, and units."
3641 },
3642 "immutable": true,
3643 "locationInModule": {
3644 "filename": "lib/cloudwatch.generated.ts",
3645 "line": 1558
3646 },
3647 "name": "metricStat",
3648 "optional": true,
3649 "type": {
3650 "union": {
3651 "types": [
3652 {
3653 "fqn": "@aws-cdk/core.IResolvable"
3654 },
3655 {
3656 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.MetricStatProperty"
3657 }
3658 ]
3659 }
3660 }
3661 },
3662 {
3663 "abstract": true,
3664 "docs": {
3665 "custom": {
3666 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html#cfn-cloudwatch-anomalydetector-metricdataquery-period"
3667 },
3668 "remarks": "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` .",
3669 "stability": "external",
3670 "summary": "The granularity, in seconds, of the returned data points."
3671 },
3672 "immutable": true,
3673 "locationInModule": {
3674 "filename": "lib/cloudwatch.generated.ts",
3675 "line": 1564
3676 },
3677 "name": "period",
3678 "optional": true,
3679 "type": {
3680 "primitive": "number"
3681 }
3682 },
3683 {
3684 "abstract": true,
3685 "docs": {
3686 "custom": {
3687 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html#cfn-cloudwatch-anomalydetector-metricdataquery-returndata"
3688 },
3689 "remarks": "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.\n\nWhen 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.",
3690 "stability": "external",
3691 "summary": "When used in `GetMetricData` , this option indicates whether to return the timestamps and raw data values of this metric."
3692 },
3693 "immutable": true,
3694 "locationInModule": {
3695 "filename": "lib/cloudwatch.generated.ts",
3696 "line": 1572
3697 },
3698 "name": "returnData",
3699 "optional": true,
3700 "type": {
3701 "union": {
3702 "types": [
3703 {
3704 "primitive": "boolean"
3705 },
3706 {
3707 "fqn": "@aws-cdk/core.IResolvable"
3708 }
3709 ]
3710 }
3711 }
3712 }
3713 ],
3714 "symbolId": "lib/cloudwatch.generated:CfnAnomalyDetector.MetricDataQueryProperty"
3715 },
3716 "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.MetricMathAnomalyDetectorProperty": {
3717 "assembly": "@aws-cdk/aws-cloudwatch",
3718 "datatype": true,
3719 "docs": {
3720 "custom": {
3721 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricmathanomalydetector.html",
3722 "exampleMetadata": "fixture=_generated"
3723 },
3724 "remarks": "The designated math expression must return a single time series.",
3725 "stability": "external",
3726 "summary": "Indicates the CloudWatch math expression that provides the time series the anomaly detector uses as input.",
3727 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst metricMathAnomalyDetectorProperty: cloudwatch.CfnAnomalyDetector.MetricMathAnomalyDetectorProperty = {\n metricDataQueries: [{\n id: 'id',\n\n // the properties below are optional\n accountId: 'accountId',\n expression: 'expression',\n label: 'label',\n metricStat: {\n metric: {\n metricName: 'metricName',\n namespace: 'namespace',\n\n // the properties below are optional\n dimensions: [{\n name: 'name',\n value: 'value',\n }],\n },\n period: 123,\n stat: 'stat',\n\n // the properties below are optional\n unit: 'unit',\n },\n period: 123,\n returnData: false,\n }],\n};"
3728 },
3729 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.MetricMathAnomalyDetectorProperty",
3730 "kind": "interface",
3731 "locationInModule": {
3732 "filename": "lib/cloudwatch.generated.ts",
3733 "line": 1652
3734 },
3735 "name": "MetricMathAnomalyDetectorProperty",
3736 "namespace": "CfnAnomalyDetector",
3737 "properties": [
3738 {
3739 "abstract": true,
3740 "docs": {
3741 "custom": {
3742 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricmathanomalydetector.html#cfn-cloudwatch-anomalydetector-metricmathanomalydetector-metricdataqueries"
3743 },
3744 "remarks": "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.",
3745 "stability": "external",
3746 "summary": "An array of metric data query structures that enables you to create an anomaly detector based on the result of a metric math expression."
3747 },
3748 "immutable": true,
3749 "locationInModule": {
3750 "filename": "lib/cloudwatch.generated.ts",
3751 "line": 1658
3752 },
3753 "name": "metricDataQueries",
3754 "optional": true,
3755 "type": {
3756 "union": {
3757 "types": [
3758 {
3759 "fqn": "@aws-cdk/core.IResolvable"
3760 },
3761 {
3762 "collection": {
3763 "elementtype": {
3764 "union": {
3765 "types": [
3766 {
3767 "fqn": "@aws-cdk/core.IResolvable"
3768 },
3769 {
3770 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.MetricDataQueryProperty"
3771 }
3772 ]
3773 }
3774 },
3775 "kind": "array"
3776 }
3777 }
3778 ]
3779 }
3780 }
3781 }
3782 ],
3783 "symbolId": "lib/cloudwatch.generated:CfnAnomalyDetector.MetricMathAnomalyDetectorProperty"
3784 },
3785 "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.MetricProperty": {
3786 "assembly": "@aws-cdk/aws-cloudwatch",
3787 "datatype": true,
3788 "docs": {
3789 "custom": {
3790 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metric.html",
3791 "exampleMetadata": "fixture=_generated"
3792 },
3793 "stability": "external",
3794 "summary": "Represents a specific metric.",
3795 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst metricProperty: cloudwatch.CfnAnomalyDetector.MetricProperty = {\n metricName: 'metricName',\n namespace: 'namespace',\n\n // the properties below are optional\n dimensions: [{\n name: 'name',\n value: 'value',\n }],\n};"
3796 },
3797 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.MetricProperty",
3798 "kind": "interface",
3799 "locationInModule": {
3800 "filename": "lib/cloudwatch.generated.ts",
3801 "line": 1423
3802 },
3803 "name": "MetricProperty",
3804 "namespace": "CfnAnomalyDetector",
3805 "properties": [
3806 {
3807 "abstract": true,
3808 "docs": {
3809 "custom": {
3810 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metric.html#cfn-cloudwatch-anomalydetector-metric-metricname"
3811 },
3812 "remarks": "This is a required field.",
3813 "stability": "external",
3814 "summary": "The name of the metric."
3815 },
3816 "immutable": true,
3817 "locationInModule": {
3818 "filename": "lib/cloudwatch.generated.ts",
3819 "line": 1435
3820 },
3821 "name": "metricName",
3822 "type": {
3823 "primitive": "string"
3824 }
3825 },
3826 {
3827 "abstract": true,
3828 "docs": {
3829 "custom": {
3830 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metric.html#cfn-cloudwatch-anomalydetector-metric-namespace"
3831 },
3832 "stability": "external",
3833 "summary": "The namespace of the metric."
3834 },
3835 "immutable": true,
3836 "locationInModule": {
3837 "filename": "lib/cloudwatch.generated.ts",
3838 "line": 1441
3839 },
3840 "name": "namespace",
3841 "type": {
3842 "primitive": "string"
3843 }
3844 },
3845 {
3846 "abstract": true,
3847 "docs": {
3848 "custom": {
3849 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metric.html#cfn-cloudwatch-anomalydetector-metric-dimensions"
3850 },
3851 "stability": "external",
3852 "summary": "The dimensions for the metric."
3853 },
3854 "immutable": true,
3855 "locationInModule": {
3856 "filename": "lib/cloudwatch.generated.ts",
3857 "line": 1429
3858 },
3859 "name": "dimensions",
3860 "optional": true,
3861 "type": {
3862 "union": {
3863 "types": [
3864 {
3865 "fqn": "@aws-cdk/core.IResolvable"
3866 },
3867 {
3868 "collection": {
3869 "elementtype": {
3870 "union": {
3871 "types": [
3872 {
3873 "fqn": "@aws-cdk/core.IResolvable"
3874 },
3875 {
3876 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.DimensionProperty"
3877 }
3878 ]
3879 }
3880 },
3881 "kind": "array"
3882 }
3883 }
3884 ]
3885 }
3886 }
3887 }
3888 ],
3889 "symbolId": "lib/cloudwatch.generated:CfnAnomalyDetector.MetricProperty"
3890 },
3891 "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.MetricStatProperty": {
3892 "assembly": "@aws-cdk/aws-cloudwatch",
3893 "datatype": true,
3894 "docs": {
3895 "custom": {
3896 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricstat.html",
3897 "exampleMetadata": "fixture=_generated"
3898 },
3899 "stability": "external",
3900 "summary": "This structure defines the metric to be returned, along with the statistics, period, and units.",
3901 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst metricStatProperty: cloudwatch.CfnAnomalyDetector.MetricStatProperty = {\n metric: {\n metricName: 'metricName',\n namespace: 'namespace',\n\n // the properties below are optional\n dimensions: [{\n name: 'name',\n value: 'value',\n }],\n },\n period: 123,\n stat: 'stat',\n\n // the properties below are optional\n unit: 'unit',\n};"
3902 },
3903 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.MetricStatProperty",
3904 "kind": "interface",
3905 "locationInModule": {
3906 "filename": "lib/cloudwatch.generated.ts",
3907 "line": 1719
3908 },
3909 "name": "MetricStatProperty",
3910 "namespace": "CfnAnomalyDetector",
3911 "properties": [
3912 {
3913 "abstract": true,
3914 "docs": {
3915 "custom": {
3916 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricstat.html#cfn-cloudwatch-anomalydetector-metricstat-metric"
3917 },
3918 "stability": "external",
3919 "summary": "The metric to return, including the metric name, namespace, and dimensions."
3920 },
3921 "immutable": true,
3922 "locationInModule": {
3923 "filename": "lib/cloudwatch.generated.ts",
3924 "line": 1725
3925 },
3926 "name": "metric",
3927 "type": {
3928 "union": {
3929 "types": [
3930 {
3931 "fqn": "@aws-cdk/core.IResolvable"
3932 },
3933 {
3934 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.MetricProperty"
3935 }
3936 ]
3937 }
3938 }
3939 },
3940 {
3941 "abstract": true,
3942 "docs": {
3943 "custom": {
3944 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricstat.html#cfn-cloudwatch-anomalydetector-metricstat-period"
3945 },
3946 "remarks": "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.\n\nIf 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:\n\n- Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).\n- Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).\n- Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).",
3947 "stability": "external",
3948 "summary": "The granularity, in seconds, of the returned data points."
3949 },
3950 "immutable": true,
3951 "locationInModule": {
3952 "filename": "lib/cloudwatch.generated.ts",
3953 "line": 1737
3954 },
3955 "name": "period",
3956 "type": {
3957 "primitive": "number"
3958 }
3959 },
3960 {
3961 "abstract": true,
3962 "docs": {
3963 "custom": {
3964 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricstat.html#cfn-cloudwatch-anomalydetector-metricstat-stat"
3965 },
3966 "remarks": "It can include any CloudWatch statistic or extended statistic.",
3967 "stability": "external",
3968 "summary": "The statistic to return."
3969 },
3970 "immutable": true,
3971 "locationInModule": {
3972 "filename": "lib/cloudwatch.generated.ts",
3973 "line": 1743
3974 },
3975 "name": "stat",
3976 "type": {
3977 "primitive": "string"
3978 }
3979 },
3980 {
3981 "abstract": true,
3982 "docs": {
3983 "custom": {
3984 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricstat.html#cfn-cloudwatch-anomalydetector-metricstat-unit"
3985 },
3986 "remarks": "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.",
3987 "stability": "external",
3988 "summary": "When you are using a `Put` operation, this defines what unit you want to use when storing the metric."
3989 },
3990 "immutable": true,
3991 "locationInModule": {
3992 "filename": "lib/cloudwatch.generated.ts",
3993 "line": 1751
3994 },
3995 "name": "unit",
3996 "optional": true,
3997 "type": {
3998 "primitive": "string"
3999 }
4000 }
4001 ],
4002 "symbolId": "lib/cloudwatch.generated:CfnAnomalyDetector.MetricStatProperty"
4003 },
4004 "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.RangeProperty": {
4005 "assembly": "@aws-cdk/aws-cloudwatch",
4006 "datatype": true,
4007 "docs": {
4008 "custom": {
4009 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-range.html",
4010 "exampleMetadata": "fixture=_generated"
4011 },
4012 "stability": "external",
4013 "summary": "Each `Range` specifies one range of days or times to exclude from use for training or updating an anomaly detection model.",
4014 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst rangeProperty: cloudwatch.CfnAnomalyDetector.RangeProperty = {\n endTime: 'endTime',\n startTime: 'startTime',\n};"
4015 },
4016 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.RangeProperty",
4017 "kind": "interface",
4018 "locationInModule": {
4019 "filename": "lib/cloudwatch.generated.ts",
4020 "line": 1824
4021 },
4022 "name": "RangeProperty",
4023 "namespace": "CfnAnomalyDetector",
4024 "properties": [
4025 {
4026 "abstract": true,
4027 "docs": {
4028 "custom": {
4029 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-range.html#cfn-cloudwatch-anomalydetector-range-endtime"
4030 },
4031 "remarks": "The format is `yyyy-MM-dd'T'HH:mm:ss` . For example, `2019-07-01T23:59:59` .",
4032 "stability": "external",
4033 "summary": "The end time of the range to exclude."
4034 },
4035 "immutable": true,
4036 "locationInModule": {
4037 "filename": "lib/cloudwatch.generated.ts",
4038 "line": 1830
4039 },
4040 "name": "endTime",
4041 "type": {
4042 "primitive": "string"
4043 }
4044 },
4045 {
4046 "abstract": true,
4047 "docs": {
4048 "custom": {
4049 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-range.html#cfn-cloudwatch-anomalydetector-range-starttime"
4050 },
4051 "remarks": "The format is `yyyy-MM-dd'T'HH:mm:ss` . For example, `2019-07-01T23:59:59` .",
4052 "stability": "external",
4053 "summary": "The start time of the range to exclude."
4054 },
4055 "immutable": true,
4056 "locationInModule": {
4057 "filename": "lib/cloudwatch.generated.ts",
4058 "line": 1836
4059 },
4060 "name": "startTime",
4061 "type": {
4062 "primitive": "string"
4063 }
4064 }
4065 ],
4066 "symbolId": "lib/cloudwatch.generated:CfnAnomalyDetector.RangeProperty"
4067 },
4068 "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.SingleMetricAnomalyDetectorProperty": {
4069 "assembly": "@aws-cdk/aws-cloudwatch",
4070 "datatype": true,
4071 "docs": {
4072 "custom": {
4073 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-singlemetricanomalydetector.html",
4074 "exampleMetadata": "fixture=_generated"
4075 },
4076 "stability": "external",
4077 "summary": "Designates the CloudWatch metric and statistic that provides the time series the anomaly detector uses as input.",
4078 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst singleMetricAnomalyDetectorProperty: cloudwatch.CfnAnomalyDetector.SingleMetricAnomalyDetectorProperty = {\n dimensions: [{\n name: 'name',\n value: 'value',\n }],\n metricName: 'metricName',\n namespace: 'namespace',\n stat: 'stat',\n};"
4079 },
4080 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.SingleMetricAnomalyDetectorProperty",
4081 "kind": "interface",
4082 "locationInModule": {
4083 "filename": "lib/cloudwatch.generated.ts",
4084 "line": 1902
4085 },
4086 "name": "SingleMetricAnomalyDetectorProperty",
4087 "namespace": "CfnAnomalyDetector",
4088 "properties": [
4089 {
4090 "abstract": true,
4091 "docs": {
4092 "custom": {
4093 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-singlemetricanomalydetector.html#cfn-cloudwatch-anomalydetector-singlemetricanomalydetector-dimensions"
4094 },
4095 "stability": "external",
4096 "summary": "The metric dimensions to create the anomaly detection model for."
4097 },
4098 "immutable": true,
4099 "locationInModule": {
4100 "filename": "lib/cloudwatch.generated.ts",
4101 "line": 1908
4102 },
4103 "name": "dimensions",
4104 "optional": true,
4105 "type": {
4106 "union": {
4107 "types": [
4108 {
4109 "fqn": "@aws-cdk/core.IResolvable"
4110 },
4111 {
4112 "collection": {
4113 "elementtype": {
4114 "union": {
4115 "types": [
4116 {
4117 "fqn": "@aws-cdk/core.IResolvable"
4118 },
4119 {
4120 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.DimensionProperty"
4121 }
4122 ]
4123 }
4124 },
4125 "kind": "array"
4126 }
4127 }
4128 ]
4129 }
4130 }
4131 },
4132 {
4133 "abstract": true,
4134 "docs": {
4135 "custom": {
4136 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-singlemetricanomalydetector.html#cfn-cloudwatch-anomalydetector-singlemetricanomalydetector-metricname"
4137 },
4138 "stability": "external",
4139 "summary": "The name of the metric to create the anomaly detection model for."
4140 },
4141 "immutable": true,
4142 "locationInModule": {
4143 "filename": "lib/cloudwatch.generated.ts",
4144 "line": 1914
4145 },
4146 "name": "metricName",
4147 "optional": true,
4148 "type": {
4149 "primitive": "string"
4150 }
4151 },
4152 {
4153 "abstract": true,
4154 "docs": {
4155 "custom": {
4156 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-singlemetricanomalydetector.html#cfn-cloudwatch-anomalydetector-singlemetricanomalydetector-namespace"
4157 },
4158 "stability": "external",
4159 "summary": "The namespace of the metric to create the anomaly detection model for."
4160 },
4161 "immutable": true,
4162 "locationInModule": {
4163 "filename": "lib/cloudwatch.generated.ts",
4164 "line": 1920
4165 },
4166 "name": "namespace",
4167 "optional": true,
4168 "type": {
4169 "primitive": "string"
4170 }
4171 },
4172 {
4173 "abstract": true,
4174 "docs": {
4175 "custom": {
4176 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-singlemetricanomalydetector.html#cfn-cloudwatch-anomalydetector-singlemetricanomalydetector-stat"
4177 },
4178 "stability": "external",
4179 "summary": "The statistic to use for the metric and anomaly detection model."
4180 },
4181 "immutable": true,
4182 "locationInModule": {
4183 "filename": "lib/cloudwatch.generated.ts",
4184 "line": 1926
4185 },
4186 "name": "stat",
4187 "optional": true,
4188 "type": {
4189 "primitive": "string"
4190 }
4191 }
4192 ],
4193 "symbolId": "lib/cloudwatch.generated:CfnAnomalyDetector.SingleMetricAnomalyDetectorProperty"
4194 },
4195 "@aws-cdk/aws-cloudwatch.CfnAnomalyDetectorProps": {
4196 "assembly": "@aws-cdk/aws-cloudwatch",
4197 "datatype": true,
4198 "docs": {
4199 "custom": {
4200 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html",
4201 "exampleMetadata": "fixture=_generated"
4202 },
4203 "stability": "external",
4204 "summary": "Properties for defining a `CfnAnomalyDetector`.",
4205 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst cfnAnomalyDetectorProps: cloudwatch.CfnAnomalyDetectorProps = {\n configuration: {\n excludedTimeRanges: [{\n endTime: 'endTime',\n startTime: 'startTime',\n }],\n metricTimeZone: 'metricTimeZone',\n },\n dimensions: [{\n name: 'name',\n value: 'value',\n }],\n metricMathAnomalyDetector: {\n metricDataQueries: [{\n id: 'id',\n\n // the properties below are optional\n accountId: 'accountId',\n expression: 'expression',\n label: 'label',\n metricStat: {\n metric: {\n metricName: 'metricName',\n namespace: 'namespace',\n\n // the properties below are optional\n dimensions: [{\n name: 'name',\n value: 'value',\n }],\n },\n period: 123,\n stat: 'stat',\n\n // the properties below are optional\n unit: 'unit',\n },\n period: 123,\n returnData: false,\n }],\n },\n metricName: 'metricName',\n namespace: 'namespace',\n singleMetricAnomalyDetector: {\n dimensions: [{\n name: 'name',\n value: 'value',\n }],\n metricName: 'metricName',\n namespace: 'namespace',\n stat: 'stat',\n },\n stat: 'stat',\n};"
4206 },
4207 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetectorProps",
4208 "kind": "interface",
4209 "locationInModule": {
4210 "filename": "lib/cloudwatch.generated.ts",
4211 "line": 1010
4212 },
4213 "name": "CfnAnomalyDetectorProps",
4214 "properties": [
4215 {
4216 "abstract": true,
4217 "docs": {
4218 "custom": {
4219 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-configuration"
4220 },
4221 "remarks": "The configuration can also include the time zone to use for the metric.",
4222 "stability": "external",
4223 "summary": "Specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model."
4224 },
4225 "immutable": true,
4226 "locationInModule": {
4227 "filename": "lib/cloudwatch.generated.ts",
4228 "line": 1017
4229 },
4230 "name": "configuration",
4231 "optional": true,
4232 "type": {
4233 "union": {
4234 "types": [
4235 {
4236 "fqn": "@aws-cdk/core.IResolvable"
4237 },
4238 {
4239 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.ConfigurationProperty"
4240 }
4241 ]
4242 }
4243 }
4244 },
4245 {
4246 "abstract": true,
4247 "docs": {
4248 "custom": {
4249 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-dimensions"
4250 },
4251 "stability": "external",
4252 "summary": "The dimensions of the metric associated with the anomaly detection band."
4253 },
4254 "immutable": true,
4255 "locationInModule": {
4256 "filename": "lib/cloudwatch.generated.ts",
4257 "line": 1024
4258 },
4259 "name": "dimensions",
4260 "optional": true,
4261 "type": {
4262 "union": {
4263 "types": [
4264 {
4265 "fqn": "@aws-cdk/core.IResolvable"
4266 },
4267 {
4268 "collection": {
4269 "elementtype": {
4270 "union": {
4271 "types": [
4272 {
4273 "fqn": "@aws-cdk/core.IResolvable"
4274 },
4275 {
4276 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.DimensionProperty"
4277 }
4278 ]
4279 }
4280 },
4281 "kind": "array"
4282 }
4283 }
4284 ]
4285 }
4286 }
4287 },
4288 {
4289 "abstract": true,
4290 "docs": {
4291 "custom": {
4292 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-metricmathanomalydetector"
4293 },
4294 "stability": "external",
4295 "summary": "The CloudWatch metric math expression for this anomaly detector."
4296 },
4297 "immutable": true,
4298 "locationInModule": {
4299 "filename": "lib/cloudwatch.generated.ts",
4300 "line": 1031
4301 },
4302 "name": "metricMathAnomalyDetector",
4303 "optional": true,
4304 "type": {
4305 "union": {
4306 "types": [
4307 {
4308 "fqn": "@aws-cdk/core.IResolvable"
4309 },
4310 {
4311 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.MetricMathAnomalyDetectorProperty"
4312 }
4313 ]
4314 }
4315 }
4316 },
4317 {
4318 "abstract": true,
4319 "docs": {
4320 "custom": {
4321 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-metricname"
4322 },
4323 "stability": "external",
4324 "summary": "The name of the metric associated with the anomaly detection band."
4325 },
4326 "immutable": true,
4327 "locationInModule": {
4328 "filename": "lib/cloudwatch.generated.ts",
4329 "line": 1038
4330 },
4331 "name": "metricName",
4332 "optional": true,
4333 "type": {
4334 "primitive": "string"
4335 }
4336 },
4337 {
4338 "abstract": true,
4339 "docs": {
4340 "custom": {
4341 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-namespace"
4342 },
4343 "stability": "external",
4344 "summary": "The namespace of the metric associated with the anomaly detection band."
4345 },
4346 "immutable": true,
4347 "locationInModule": {
4348 "filename": "lib/cloudwatch.generated.ts",
4349 "line": 1045
4350 },
4351 "name": "namespace",
4352 "optional": true,
4353 "type": {
4354 "primitive": "string"
4355 }
4356 },
4357 {
4358 "abstract": true,
4359 "docs": {
4360 "custom": {
4361 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-singlemetricanomalydetector"
4362 },
4363 "stability": "external",
4364 "summary": "The CloudWatch metric and statistic for this anomaly detector."
4365 },
4366 "immutable": true,
4367 "locationInModule": {
4368 "filename": "lib/cloudwatch.generated.ts",
4369 "line": 1052
4370 },
4371 "name": "singleMetricAnomalyDetector",
4372 "optional": true,
4373 "type": {
4374 "union": {
4375 "types": [
4376 {
4377 "fqn": "@aws-cdk/core.IResolvable"
4378 },
4379 {
4380 "fqn": "@aws-cdk/aws-cloudwatch.CfnAnomalyDetector.SingleMetricAnomalyDetectorProperty"
4381 }
4382 ]
4383 }
4384 }
4385 },
4386 {
4387 "abstract": true,
4388 "docs": {
4389 "custom": {
4390 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-stat"
4391 },
4392 "stability": "external",
4393 "summary": "The statistic of the metric associated with the anomaly detection band."
4394 },
4395 "immutable": true,
4396 "locationInModule": {
4397 "filename": "lib/cloudwatch.generated.ts",
4398 "line": 1059
4399 },
4400 "name": "stat",
4401 "optional": true,
4402 "type": {
4403 "primitive": "string"
4404 }
4405 }
4406 ],
4407 "symbolId": "lib/cloudwatch.generated:CfnAnomalyDetectorProps"
4408 },
4409 "@aws-cdk/aws-cloudwatch.CfnCompositeAlarm": {
4410 "assembly": "@aws-cdk/aws-cloudwatch",
4411 "base": "@aws-cdk/core.CfnResource",
4412 "docs": {
4413 "custom": {
4414 "cloudformationResource": "AWS::CloudWatch::CompositeAlarm",
4415 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html",
4416 "exampleMetadata": "fixture=_generated"
4417 },
4418 "remarks": "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.\n\nThe alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.\n\nUsing 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.\n\nCurrently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.\n\nWhen 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.\n\nWhen you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.",
4419 "stability": "external",
4420 "summary": "A CloudFormation `AWS::CloudWatch::CompositeAlarm`.",
4421 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst cfnCompositeAlarm = new cloudwatch.CfnCompositeAlarm(this, 'MyCfnCompositeAlarm', {\n alarmName: 'alarmName',\n alarmRule: 'alarmRule',\n\n // the properties below are optional\n actionsEnabled: false,\n alarmActions: ['alarmActions'],\n alarmDescription: 'alarmDescription',\n insufficientDataActions: ['insufficientDataActions'],\n okActions: ['okActions'],\n});"
4422 },
4423 "fqn": "@aws-cdk/aws-cloudwatch.CfnCompositeAlarm",
4424 "initializer": {
4425 "docs": {
4426 "stability": "external",
4427 "summary": "Create a new `AWS::CloudWatch::CompositeAlarm`."
4428 },
4429 "locationInModule": {
4430 "filename": "lib/cloudwatch.generated.ts",
4431 "line": 2247
4432 },
4433 "parameters": [
4434 {
4435 "docs": {
4436 "summary": "- scope in which this resource is defined."
4437 },
4438 "name": "scope",
4439 "type": {
4440 "fqn": "@aws-cdk/core.Construct"
4441 }
4442 },
4443 {
4444 "docs": {
4445 "summary": "- scoped id of the resource."
4446 },
4447 "name": "id",
4448 "type": {
4449 "primitive": "string"
4450 }
4451 },
4452 {
4453 "docs": {
4454 "summary": "- resource properties."
4455 },
4456 "name": "props",
4457 "type": {
4458 "fqn": "@aws-cdk/aws-cloudwatch.CfnCompositeAlarmProps"
4459 }
4460 }
4461 ]
4462 },
4463 "interfaces": [
4464 "@aws-cdk/core.IInspectable"
4465 ],
4466 "kind": "class",
4467 "locationInModule": {
4468 "filename": "lib/cloudwatch.generated.ts",
4469 "line": 2146
4470 },
4471 "methods": [
4472 {
4473 "docs": {
4474 "stability": "external",
4475 "summary": "Examines the CloudFormation resource and discloses attributes."
4476 },
4477 "locationInModule": {
4478 "filename": "lib/cloudwatch.generated.ts",
4479 "line": 2268
4480 },
4481 "name": "inspect",
4482 "overrides": "@aws-cdk/core.IInspectable",
4483 "parameters": [
4484 {
4485 "docs": {
4486 "summary": "- tree inspector to collect and process attributes."
4487 },
4488 "name": "inspector",
4489 "type": {
4490 "fqn": "@aws-cdk/core.TreeInspector"
4491 }
4492 }
4493 ]
4494 },
4495 {
4496 "docs": {
4497 "stability": "external"
4498 },
4499 "locationInModule": {
4500 "filename": "lib/cloudwatch.generated.ts",
4501 "line": 2285
4502 },
4503 "name": "renderProperties",
4504 "overrides": "@aws-cdk/core.CfnResource",
4505 "parameters": [
4506 {
4507 "name": "props",
4508 "type": {
4509 "collection": {
4510 "elementtype": {
4511 "primitive": "any"
4512 },
4513 "kind": "map"
4514 }
4515 }
4516 }
4517 ],
4518 "protected": true,
4519 "returns": {
4520 "type": {
4521 "collection": {
4522 "elementtype": {
4523 "primitive": "any"
4524 },
4525 "kind": "map"
4526 }
4527 }
4528 }
4529 }
4530 ],
4531 "name": "CfnCompositeAlarm",
4532 "properties": [
4533 {
4534 "const": true,
4535 "docs": {
4536 "stability": "external",
4537 "summary": "The CloudFormation resource type name for this resource class."
4538 },
4539 "immutable": true,
4540 "locationInModule": {
4541 "filename": "lib/cloudwatch.generated.ts",
4542 "line": 2150
4543 },
4544 "name": "CFN_RESOURCE_TYPE_NAME",
4545 "static": true,
4546 "type": {
4547 "primitive": "string"
4548 }
4549 },
4550 {
4551 "docs": {
4552 "custom": {
4553 "cloudformationAttribute": "Arn"
4554 },
4555 "stability": "external",
4556 "summary": "The ARN of the composite alarm, such as `arn:aws:cloudwatch:us-west-2:123456789012:alarm/CompositeAlarmName` ."
4557 },
4558 "immutable": true,
4559 "locationInModule": {
4560 "filename": "lib/cloudwatch.generated.ts",
4561 "line": 2175
4562 },
4563 "name": "attrArn",
4564 "type": {
4565 "primitive": "string"
4566 }
4567 },
4568 {
4569 "docs": {
4570 "stability": "external"
4571 },
4572 "immutable": true,
4573 "locationInModule": {
4574 "filename": "lib/cloudwatch.generated.ts",
4575 "line": 2273
4576 },
4577 "name": "cfnProperties",
4578 "overrides": "@aws-cdk/core.CfnResource",
4579 "protected": true,
4580 "type": {
4581 "collection": {
4582 "elementtype": {
4583 "primitive": "any"
4584 },
4585 "kind": "map"
4586 }
4587 }
4588 },
4589 {
4590 "docs": {
4591 "custom": {
4592 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmname"
4593 },
4594 "remarks": "This name must be unique within your AWS account.",
4595 "stability": "external",
4596 "summary": "The name for the composite alarm."
4597 },
4598 "locationInModule": {
4599 "filename": "lib/cloudwatch.generated.ts",
4600 "line": 2182
4601 },
4602 "name": "alarmName",
4603 "type": {
4604 "primitive": "string"
4605 }
4606 },
4607 {
4608 "docs": {
4609 "custom": {
4610 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmrule"
4611 },
4612 "remarks": "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.\n\nYou can use either alarm names or ARNs to reference the other alarms that are to be evaluated.\n\nFunctions can include the following:\n\n- ALARM(\"alarm-name or alarm-ARN\") is TRUE if the named alarm is in ALARM state.\n- OK(\"alarm-name or alarm-ARN\") is TRUE if the named alarm is in OK state.\n- INSUFFICIENT_DATA(\"alarm-name or alarm-ARN\") is TRUE if the named alarm is in INSUFFICIENT_DATA state.\n- TRUE always evaluates to TRUE.\n- FALSE always evaluates to FALSE.\n\nTRUE and FALSE are useful for testing a complex AlarmRule structure, and for testing your alarm actions.\n\nFor more information about `AlarmRule` syntax, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the *Amazon CloudWatch API Reference* .",
4613 "stability": "external",
4614 "summary": "An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state."
4615 },
4616 "locationInModule": {
4617 "filename": "lib/cloudwatch.generated.ts",
4618 "line": 2203
4619 },
4620 "name": "alarmRule",
4621 "type": {
4622 "primitive": "string"
4623 }
4624 },
4625 {
4626 "docs": {
4627 "custom": {
4628 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionsenabled"
4629 },
4630 "remarks": "The default is TRUE.",
4631 "stability": "external",
4632 "summary": "Indicates whether actions should be executed during any changes to the alarm state of the composite alarm."
4633 },
4634 "locationInModule": {
4635 "filename": "lib/cloudwatch.generated.ts",
4636 "line": 2210
4637 },
4638 "name": "actionsEnabled",
4639 "optional": true,
4640 "type": {
4641 "union": {
4642 "types": [
4643 {
4644 "primitive": "boolean"
4645 },
4646 {
4647 "fqn": "@aws-cdk/core.IResolvable"
4648 }
4649 ]
4650 }
4651 }
4652 },
4653 {
4654 "docs": {
4655 "custom": {
4656 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmactions"
4657 },
4658 "remarks": "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* .",
4659 "stability": "external",
4660 "summary": "The actions to execute when this alarm transitions to the ALARM state from any other state."
4661 },
4662 "locationInModule": {
4663 "filename": "lib/cloudwatch.generated.ts",
4664 "line": 2217
4665 },
4666 "name": "alarmActions",
4667 "optional": true,
4668 "type": {
4669 "collection": {
4670 "elementtype": {
4671 "primitive": "string"
4672 },
4673 "kind": "array"
4674 }
4675 }
4676 },
4677 {
4678 "docs": {
4679 "custom": {
4680 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmdescription"
4681 },
4682 "stability": "external",
4683 "summary": "The description for the composite alarm."
4684 },
4685 "locationInModule": {
4686 "filename": "lib/cloudwatch.generated.ts",
4687 "line": 2224
4688 },
4689 "name": "alarmDescription",
4690 "optional": true,
4691 "type": {
4692 "primitive": "string"
4693 }
4694 },
4695 {
4696 "docs": {
4697 "custom": {
4698 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-insufficientdataactions"
4699 },
4700 "remarks": "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* .",
4701 "stability": "external",
4702 "summary": "The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state."
4703 },
4704 "locationInModule": {
4705 "filename": "lib/cloudwatch.generated.ts",
4706 "line": 2231
4707 },
4708 "name": "insufficientDataActions",
4709 "optional": true,
4710 "type": {
4711 "collection": {
4712 "elementtype": {
4713 "primitive": "string"
4714 },
4715 "kind": "array"
4716 }
4717 }
4718 },
4719 {
4720 "docs": {
4721 "custom": {
4722 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-okactions"
4723 },
4724 "remarks": "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* .",
4725 "stability": "external",
4726 "summary": "The actions to execute when this alarm transitions to the OK state from any other state."
4727 },
4728 "locationInModule": {
4729 "filename": "lib/cloudwatch.generated.ts",
4730 "line": 2238
4731 },
4732 "name": "okActions",
4733 "optional": true,
4734 "type": {
4735 "collection": {
4736 "elementtype": {
4737 "primitive": "string"
4738 },
4739 "kind": "array"
4740 }
4741 }
4742 }
4743 ],
4744 "symbolId": "lib/cloudwatch.generated:CfnCompositeAlarm"
4745 },
4746 "@aws-cdk/aws-cloudwatch.CfnCompositeAlarmProps": {
4747 "assembly": "@aws-cdk/aws-cloudwatch",
4748 "datatype": true,
4749 "docs": {
4750 "custom": {
4751 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html",
4752 "exampleMetadata": "fixture=_generated"
4753 },
4754 "stability": "external",
4755 "summary": "Properties for defining a `CfnCompositeAlarm`.",
4756 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst cfnCompositeAlarmProps: cloudwatch.CfnCompositeAlarmProps = {\n alarmName: 'alarmName',\n alarmRule: 'alarmRule',\n\n // the properties below are optional\n actionsEnabled: false,\n alarmActions: ['alarmActions'],\n alarmDescription: 'alarmDescription',\n insufficientDataActions: ['insufficientDataActions'],\n okActions: ['okActions'],\n};"
4757 },
4758 "fqn": "@aws-cdk/aws-cloudwatch.CfnCompositeAlarmProps",
4759 "kind": "interface",
4760 "locationInModule": {
4761 "filename": "lib/cloudwatch.generated.ts",
4762 "line": 1995
4763 },
4764 "name": "CfnCompositeAlarmProps",
4765 "properties": [
4766 {
4767 "abstract": true,
4768 "docs": {
4769 "custom": {
4770 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmname"
4771 },
4772 "remarks": "This name must be unique within your AWS account.",
4773 "stability": "external",
4774 "summary": "The name for the composite alarm."
4775 },
4776 "immutable": true,
4777 "locationInModule": {
4778 "filename": "lib/cloudwatch.generated.ts",
4779 "line": 2002
4780 },
4781 "name": "alarmName",
4782 "type": {
4783 "primitive": "string"
4784 }
4785 },
4786 {
4787 "abstract": true,
4788 "docs": {
4789 "custom": {
4790 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmrule"
4791 },
4792 "remarks": "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.\n\nYou can use either alarm names or ARNs to reference the other alarms that are to be evaluated.\n\nFunctions can include the following:\n\n- ALARM(\"alarm-name or alarm-ARN\") is TRUE if the named alarm is in ALARM state.\n- OK(\"alarm-name or alarm-ARN\") is TRUE if the named alarm is in OK state.\n- INSUFFICIENT_DATA(\"alarm-name or alarm-ARN\") is TRUE if the named alarm is in INSUFFICIENT_DATA state.\n- TRUE always evaluates to TRUE.\n- FALSE always evaluates to FALSE.\n\nTRUE and FALSE are useful for testing a complex AlarmRule structure, and for testing your alarm actions.\n\nFor more information about `AlarmRule` syntax, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the *Amazon CloudWatch API Reference* .",
4793 "stability": "external",
4794 "summary": "An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state."
4795 },
4796 "immutable": true,
4797 "locationInModule": {
4798 "filename": "lib/cloudwatch.generated.ts",
4799 "line": 2023
4800 },
4801 "name": "alarmRule",
4802 "type": {
4803 "primitive": "string"
4804 }
4805 },
4806 {
4807 "abstract": true,
4808 "docs": {
4809 "custom": {
4810 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionsenabled"
4811 },
4812 "remarks": "The default is TRUE.",
4813 "stability": "external",
4814 "summary": "Indicates whether actions should be executed during any changes to the alarm state of the composite alarm."
4815 },
4816 "immutable": true,
4817 "locationInModule": {
4818 "filename": "lib/cloudwatch.generated.ts",
4819 "line": 2030
4820 },
4821 "name": "actionsEnabled",
4822 "optional": true,
4823 "type": {
4824 "union": {
4825 "types": [
4826 {
4827 "primitive": "boolean"
4828 },
4829 {
4830 "fqn": "@aws-cdk/core.IResolvable"
4831 }
4832 ]
4833 }
4834 }
4835 },
4836 {
4837 "abstract": true,
4838 "docs": {
4839 "custom": {
4840 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmactions"
4841 },
4842 "remarks": "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* .",
4843 "stability": "external",
4844 "summary": "The actions to execute when this alarm transitions to the ALARM state from any other state."
4845 },
4846 "immutable": true,
4847 "locationInModule": {
4848 "filename": "lib/cloudwatch.generated.ts",
4849 "line": 2037
4850 },
4851 "name": "alarmActions",
4852 "optional": true,
4853 "type": {
4854 "collection": {
4855 "elementtype": {
4856 "primitive": "string"
4857 },
4858 "kind": "array"
4859 }
4860 }
4861 },
4862 {
4863 "abstract": true,
4864 "docs": {
4865 "custom": {
4866 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmdescription"
4867 },
4868 "stability": "external",
4869 "summary": "The description for the composite alarm."
4870 },
4871 "immutable": true,
4872 "locationInModule": {
4873 "filename": "lib/cloudwatch.generated.ts",
4874 "line": 2044
4875 },
4876 "name": "alarmDescription",
4877 "optional": true,
4878 "type": {
4879 "primitive": "string"
4880 }
4881 },
4882 {
4883 "abstract": true,
4884 "docs": {
4885 "custom": {
4886 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-insufficientdataactions"
4887 },
4888 "remarks": "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* .",
4889 "stability": "external",
4890 "summary": "The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state."
4891 },
4892 "immutable": true,
4893 "locationInModule": {
4894 "filename": "lib/cloudwatch.generated.ts",
4895 "line": 2051
4896 },
4897 "name": "insufficientDataActions",
4898 "optional": true,
4899 "type": {
4900 "collection": {
4901 "elementtype": {
4902 "primitive": "string"
4903 },
4904 "kind": "array"
4905 }
4906 }
4907 },
4908 {
4909 "abstract": true,
4910 "docs": {
4911 "custom": {
4912 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-okactions"
4913 },
4914 "remarks": "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* .",
4915 "stability": "external",
4916 "summary": "The actions to execute when this alarm transitions to the OK state from any other state."
4917 },
4918 "immutable": true,
4919 "locationInModule": {
4920 "filename": "lib/cloudwatch.generated.ts",
4921 "line": 2058
4922 },
4923 "name": "okActions",
4924 "optional": true,
4925 "type": {
4926 "collection": {
4927 "elementtype": {
4928 "primitive": "string"
4929 },
4930 "kind": "array"
4931 }
4932 }
4933 }
4934 ],
4935 "symbolId": "lib/cloudwatch.generated:CfnCompositeAlarmProps"
4936 },
4937 "@aws-cdk/aws-cloudwatch.CfnDashboard": {
4938 "assembly": "@aws-cdk/aws-cloudwatch",
4939 "base": "@aws-cdk/core.CfnResource",
4940 "docs": {
4941 "custom": {
4942 "cloudformationResource": "AWS::CloudWatch::Dashboard",
4943 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html",
4944 "exampleMetadata": "fixture=_generated"
4945 },
4946 "remarks": "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.\n\nAll dashboards in your account are global, not region-specific.",
4947 "stability": "external",
4948 "summary": "A CloudFormation `AWS::CloudWatch::Dashboard`.",
4949 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst cfnDashboard = new cloudwatch.CfnDashboard(this, 'MyCfnDashboard', {\n dashboardBody: 'dashboardBody',\n\n // the properties below are optional\n dashboardName: 'dashboardName',\n});"
4950 },
4951 "fqn": "@aws-cdk/aws-cloudwatch.CfnDashboard",
4952 "initializer": {
4953 "docs": {
4954 "stability": "external",
4955 "summary": "Create a new `AWS::CloudWatch::Dashboard`."
4956 },
4957 "locationInModule": {
4958 "filename": "lib/cloudwatch.generated.ts",
4959 "line": 2426
4960 },
4961 "parameters": [
4962 {
4963 "docs": {
4964 "summary": "- scope in which this resource is defined."
4965 },
4966 "name": "scope",
4967 "type": {
4968 "fqn": "@aws-cdk/core.Construct"
4969 }
4970 },
4971 {
4972 "docs": {
4973 "summary": "- scoped id of the resource."
4974 },
4975 "name": "id",
4976 "type": {
4977 "primitive": "string"
4978 }
4979 },
4980 {
4981 "docs": {
4982 "summary": "- resource properties."
4983 },
4984 "name": "props",
4985 "type": {
4986 "fqn": "@aws-cdk/aws-cloudwatch.CfnDashboardProps"
4987 }
4988 }
4989 ]
4990 },
4991 "interfaces": [
4992 "@aws-cdk/core.IInspectable"
4993 ],
4994 "kind": "class",
4995 "locationInModule": {
4996 "filename": "lib/cloudwatch.generated.ts",
4997 "line": 2378
4998 },
4999 "methods": [
5000 {
5001 "docs": {
5002 "stability": "external",
5003 "summary": "Examines the CloudFormation resource and discloses attributes."
5004 },
5005 "locationInModule": {
5006 "filename": "lib/cloudwatch.generated.ts",
5007 "line": 2440
5008 },
5009 "name": "inspect",
5010 "overrides": "@aws-cdk/core.IInspectable",
5011 "parameters": [
5012 {
5013 "docs": {
5014 "summary": "- tree inspector to collect and process attributes."
5015 },
5016 "name": "inspector",
5017 "type": {
5018 "fqn": "@aws-cdk/core.TreeInspector"
5019 }
5020 }
5021 ]
5022 },
5023 {
5024 "docs": {
5025 "stability": "external"
5026 },
5027 "locationInModule": {
5028 "filename": "lib/cloudwatch.generated.ts",
5029 "line": 2452
5030 },
5031 "name": "renderProperties",
5032 "overrides": "@aws-cdk/core.CfnResource",
5033 "parameters": [
5034 {
5035 "name": "props",
5036 "type": {
5037 "collection": {
5038 "elementtype": {
5039 "primitive": "any"
5040 },
5041 "kind": "map"
5042 }
5043 }
5044 }
5045 ],
5046 "protected": true,
5047 "returns": {
5048 "type": {
5049 "collection": {
5050 "elementtype": {
5051 "primitive": "any"
5052 },
5053 "kind": "map"
5054 }
5055 }
5056 }
5057 }
5058 ],
5059 "name": "CfnDashboard",
5060 "properties": [
5061 {
5062 "const": true,
5063 "docs": {
5064 "stability": "external",
5065 "summary": "The CloudFormation resource type name for this resource class."
5066 },
5067 "immutable": true,
5068 "locationInModule": {
5069 "filename": "lib/cloudwatch.generated.ts",
5070 "line": 2382
5071 },
5072 "name": "CFN_RESOURCE_TYPE_NAME",
5073 "static": true,
5074 "type": {
5075 "primitive": "string"
5076 }
5077 },
5078 {
5079 "docs": {
5080 "stability": "external"
5081 },
5082 "immutable": true,
5083 "locationInModule": {
5084 "filename": "lib/cloudwatch.generated.ts",
5085 "line": 2445
5086 },
5087 "name": "cfnProperties",
5088 "overrides": "@aws-cdk/core.CfnResource",
5089 "protected": true,
5090 "type": {
5091 "collection": {
5092 "elementtype": {
5093 "primitive": "any"
5094 },
5095 "kind": "map"
5096 }
5097 }
5098 },
5099 {
5100 "docs": {
5101 "custom": {
5102 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html#cfn-cloudwatch-dashboard-dashboardbody"
5103 },
5104 "remarks": "This parameter is required.\n\nFor more information about the syntax, see [Dashboard Body Structure and Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html) .",
5105 "stability": "external",
5106 "summary": "The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard."
5107 },
5108 "locationInModule": {
5109 "filename": "lib/cloudwatch.generated.ts",
5110 "line": 2410
5111 },
5112 "name": "dashboardBody",
5113 "type": {
5114 "primitive": "string"
5115 }
5116 },
5117 {
5118 "docs": {
5119 "custom": {
5120 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html#cfn-cloudwatch-dashboard-dashboardname"
5121 },
5122 "remarks": "The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically.",
5123 "stability": "external",
5124 "summary": "The name of the dashboard."
5125 },
5126 "locationInModule": {
5127 "filename": "lib/cloudwatch.generated.ts",
5128 "line": 2417
5129 },
5130 "name": "dashboardName",
5131 "optional": true,
5132 "type": {
5133 "primitive": "string"
5134 }
5135 }
5136 ],
5137 "symbolId": "lib/cloudwatch.generated:CfnDashboard"
5138 },
5139 "@aws-cdk/aws-cloudwatch.CfnDashboardProps": {
5140 "assembly": "@aws-cdk/aws-cloudwatch",
5141 "datatype": true,
5142 "docs": {
5143 "custom": {
5144 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html",
5145 "exampleMetadata": "fixture=_generated"
5146 },
5147 "stability": "external",
5148 "summary": "Properties for defining a `CfnDashboard`.",
5149 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst cfnDashboardProps: cloudwatch.CfnDashboardProps = {\n dashboardBody: 'dashboardBody',\n\n // the properties below are optional\n dashboardName: 'dashboardName',\n};"
5150 },
5151 "fqn": "@aws-cdk/aws-cloudwatch.CfnDashboardProps",
5152 "kind": "interface",
5153 "locationInModule": {
5154 "filename": "lib/cloudwatch.generated.ts",
5155 "line": 2298
5156 },
5157 "name": "CfnDashboardProps",
5158 "properties": [
5159 {
5160 "abstract": true,
5161 "docs": {
5162 "custom": {
5163 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html#cfn-cloudwatch-dashboard-dashboardbody"
5164 },
5165 "remarks": "This parameter is required.\n\nFor more information about the syntax, see [Dashboard Body Structure and Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html) .",
5166 "stability": "external",
5167 "summary": "The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard."
5168 },
5169 "immutable": true,
5170 "locationInModule": {
5171 "filename": "lib/cloudwatch.generated.ts",
5172 "line": 2307
5173 },
5174 "name": "dashboardBody",
5175 "type": {
5176 "primitive": "string"
5177 }
5178 },
5179 {
5180 "abstract": true,
5181 "docs": {
5182 "custom": {
5183 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html#cfn-cloudwatch-dashboard-dashboardname"
5184 },
5185 "remarks": "The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically.",
5186 "stability": "external",
5187 "summary": "The name of the dashboard."
5188 },
5189 "immutable": true,
5190 "locationInModule": {
5191 "filename": "lib/cloudwatch.generated.ts",
5192 "line": 2314
5193 },
5194 "name": "dashboardName",
5195 "optional": true,
5196 "type": {
5197 "primitive": "string"
5198 }
5199 }
5200 ],
5201 "symbolId": "lib/cloudwatch.generated:CfnDashboardProps"
5202 },
5203 "@aws-cdk/aws-cloudwatch.CfnInsightRule": {
5204 "assembly": "@aws-cdk/aws-cloudwatch",
5205 "base": "@aws-cdk/core.CfnResource",
5206 "docs": {
5207 "custom": {
5208 "cloudformationResource": "AWS::CloudWatch::InsightRule",
5209 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html",
5210 "exampleMetadata": "fixture=_generated"
5211 },
5212 "remarks": "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* .",
5213 "stability": "external",
5214 "summary": "A CloudFormation `AWS::CloudWatch::InsightRule`.",
5215 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst cfnInsightRule = new cloudwatch.CfnInsightRule(this, 'MyCfnInsightRule', {\n ruleBody: 'ruleBody',\n ruleName: 'ruleName',\n ruleState: 'ruleState',\n\n // the properties below are optional\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});"
5216 },
5217 "fqn": "@aws-cdk/aws-cloudwatch.CfnInsightRule",
5218 "initializer": {
5219 "docs": {
5220 "stability": "external",
5221 "summary": "Create a new `AWS::CloudWatch::InsightRule`."
5222 },
5223 "locationInModule": {
5224 "filename": "lib/cloudwatch.generated.ts",
5225 "line": 2643
5226 },
5227 "parameters": [
5228 {
5229 "docs": {
5230 "summary": "- scope in which this resource is defined."
5231 },
5232 "name": "scope",
5233 "type": {
5234 "fqn": "@aws-cdk/core.Construct"
5235 }
5236 },
5237 {
5238 "docs": {
5239 "summary": "- scoped id of the resource."
5240 },
5241 "name": "id",
5242 "type": {
5243 "primitive": "string"
5244 }
5245 },
5246 {
5247 "docs": {
5248 "summary": "- resource properties."
5249 },
5250 "name": "props",
5251 "type": {
5252 "fqn": "@aws-cdk/aws-cloudwatch.CfnInsightRuleProps"
5253 }
5254 }
5255 ]
5256 },
5257 "interfaces": [
5258 "@aws-cdk/core.IInspectable"
5259 ],
5260 "kind": "class",
5261 "locationInModule": {
5262 "filename": "lib/cloudwatch.generated.ts",
5263 "line": 2567
5264 },
5265 "methods": [
5266 {
5267 "docs": {
5268 "stability": "external",
5269 "summary": "Examines the CloudFormation resource and discloses attributes."
5270 },
5271 "locationInModule": {
5272 "filename": "lib/cloudwatch.generated.ts",
5273 "line": 2663
5274 },
5275 "name": "inspect",
5276 "overrides": "@aws-cdk/core.IInspectable",
5277 "parameters": [
5278 {
5279 "docs": {
5280 "summary": "- tree inspector to collect and process attributes."
5281 },
5282 "name": "inspector",
5283 "type": {
5284 "fqn": "@aws-cdk/core.TreeInspector"
5285 }
5286 }
5287 ]
5288 },
5289 {
5290 "docs": {
5291 "stability": "external"
5292 },
5293 "locationInModule": {
5294 "filename": "lib/cloudwatch.generated.ts",
5295 "line": 2677
5296 },
5297 "name": "renderProperties",
5298 "overrides": "@aws-cdk/core.CfnResource",
5299 "parameters": [
5300 {
5301 "name": "props",
5302 "type": {
5303 "collection": {
5304 "elementtype": {
5305 "primitive": "any"
5306 },
5307 "kind": "map"
5308 }
5309 }
5310 }
5311 ],
5312 "protected": true,
5313 "returns": {
5314 "type": {
5315 "collection": {
5316 "elementtype": {
5317 "primitive": "any"
5318 },
5319 "kind": "map"
5320 }
5321 }
5322 }
5323 }
5324 ],
5325 "name": "CfnInsightRule",
5326 "properties": [
5327 {
5328 "const": true,
5329 "docs": {
5330 "stability": "external",
5331 "summary": "The CloudFormation resource type name for this resource class."
5332 },
5333 "immutable": true,
5334 "locationInModule": {
5335 "filename": "lib/cloudwatch.generated.ts",
5336 "line": 2571
5337 },
5338 "name": "CFN_RESOURCE_TYPE_NAME",
5339 "static": true,
5340 "type": {
5341 "primitive": "string"
5342 }
5343 },
5344 {
5345 "docs": {
5346 "custom": {
5347 "cloudformationAttribute": "Arn"
5348 },
5349 "stability": "external",
5350 "summary": "The ARN of the Contributor Insights rule, such as `arn:aws:cloudwatch:us-west-2:123456789012:insight-rule/MyInsightRuleName` ."
5351 },
5352 "immutable": true,
5353 "locationInModule": {
5354 "filename": "lib/cloudwatch.generated.ts",
5355 "line": 2596
5356 },
5357 "name": "attrArn",
5358 "type": {
5359 "primitive": "string"
5360 }
5361 },
5362 {
5363 "docs": {
5364 "custom": {
5365 "cloudformationAttribute": "RuleName"
5366 },
5367 "stability": "external",
5368 "summary": "The name of the Contributor Insights rule."
5369 },
5370 "immutable": true,
5371 "locationInModule": {
5372 "filename": "lib/cloudwatch.generated.ts",
5373 "line": 2602
5374 },
5375 "name": "attrRuleName",
5376 "type": {
5377 "primitive": "string"
5378 }
5379 },
5380 {
5381 "docs": {
5382 "stability": "external"
5383 },
5384 "immutable": true,
5385 "locationInModule": {
5386 "filename": "lib/cloudwatch.generated.ts",
5387 "line": 2668
5388 },
5389 "name": "cfnProperties",
5390 "overrides": "@aws-cdk/core.CfnResource",
5391 "protected": true,
5392 "type": {
5393 "collection": {
5394 "elementtype": {
5395 "primitive": "any"
5396 },
5397 "kind": "map"
5398 }
5399 }
5400 },
5401 {
5402 "docs": {
5403 "custom": {
5404 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-tags"
5405 },
5406 "remarks": "You can associate as many as 50 tags with a rule.\n\nTags 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) .\n\nTo be able to associate tags with a rule, you must have the `cloudwatch:TagResource` permission in addition to the `cloudwatch:PutInsightRule` permission.",
5407 "stability": "external",
5408 "summary": "A list of key-value pairs to associate with the Contributor Insights rule."
5409 },
5410 "immutable": true,
5411 "locationInModule": {
5412 "filename": "lib/cloudwatch.generated.ts",
5413 "line": 2634
5414 },
5415 "name": "tags",
5416 "type": {
5417 "fqn": "@aws-cdk/core.TagManager"
5418 }
5419 },
5420 {
5421 "docs": {
5422 "custom": {
5423 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulebody"
5424 },
5425 "remarks": "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* .",
5426 "stability": "external",
5427 "summary": "The definition of the rule, as a JSON object."
5428 },
5429 "locationInModule": {
5430 "filename": "lib/cloudwatch.generated.ts",
5431 "line": 2609
5432 },
5433 "name": "ruleBody",
5434 "type": {
5435 "primitive": "string"
5436 }
5437 },
5438 {
5439 "docs": {
5440 "custom": {
5441 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulename"
5442 },
5443 "stability": "external",
5444 "summary": "The name of the rule."
5445 },
5446 "locationInModule": {
5447 "filename": "lib/cloudwatch.generated.ts",
5448 "line": 2616
5449 },
5450 "name": "ruleName",
5451 "type": {
5452 "primitive": "string"
5453 }
5454 },
5455 {
5456 "docs": {
5457 "custom": {
5458 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulestate"
5459 },
5460 "remarks": "Valid values are `ENABLED` and `DISABLED` .",
5461 "stability": "external",
5462 "summary": "The current state of the rule."
5463 },
5464 "locationInModule": {
5465 "filename": "lib/cloudwatch.generated.ts",
5466 "line": 2623
5467 },
5468 "name": "ruleState",
5469 "type": {
5470 "primitive": "string"
5471 }
5472 }
5473 ],
5474 "symbolId": "lib/cloudwatch.generated:CfnInsightRule"
5475 },
5476 "@aws-cdk/aws-cloudwatch.CfnInsightRuleProps": {
5477 "assembly": "@aws-cdk/aws-cloudwatch",
5478 "datatype": true,
5479 "docs": {
5480 "custom": {
5481 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html",
5482 "exampleMetadata": "fixture=_generated"
5483 },
5484 "stability": "external",
5485 "summary": "Properties for defining a `CfnInsightRule`.",
5486 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst cfnInsightRuleProps: cloudwatch.CfnInsightRuleProps = {\n ruleBody: 'ruleBody',\n ruleName: 'ruleName',\n ruleState: 'ruleState',\n\n // the properties below are optional\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};"
5487 },
5488 "fqn": "@aws-cdk/aws-cloudwatch.CfnInsightRuleProps",
5489 "kind": "interface",
5490 "locationInModule": {
5491 "filename": "lib/cloudwatch.generated.ts",
5492 "line": 2465
5493 },
5494 "name": "CfnInsightRuleProps",
5495 "properties": [
5496 {
5497 "abstract": true,
5498 "docs": {
5499 "custom": {
5500 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulebody"
5501 },
5502 "remarks": "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* .",
5503 "stability": "external",
5504 "summary": "The definition of the rule, as a JSON object."
5505 },
5506 "immutable": true,
5507 "locationInModule": {
5508 "filename": "lib/cloudwatch.generated.ts",
5509 "line": 2472
5510 },
5511 "name": "ruleBody",
5512 "type": {
5513 "primitive": "string"
5514 }
5515 },
5516 {
5517 "abstract": true,
5518 "docs": {
5519 "custom": {
5520 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulename"
5521 },
5522 "stability": "external",
5523 "summary": "The name of the rule."
5524 },
5525 "immutable": true,
5526 "locationInModule": {
5527 "filename": "lib/cloudwatch.generated.ts",
5528 "line": 2479
5529 },
5530 "name": "ruleName",
5531 "type": {
5532 "primitive": "string"
5533 }
5534 },
5535 {
5536 "abstract": true,
5537 "docs": {
5538 "custom": {
5539 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulestate"
5540 },
5541 "remarks": "Valid values are `ENABLED` and `DISABLED` .",
5542 "stability": "external",
5543 "summary": "The current state of the rule."
5544 },
5545 "immutable": true,
5546 "locationInModule": {
5547 "filename": "lib/cloudwatch.generated.ts",
5548 "line": 2486
5549 },
5550 "name": "ruleState",
5551 "type": {
5552 "primitive": "string"
5553 }
5554 },
5555 {
5556 "abstract": true,
5557 "docs": {
5558 "custom": {
5559 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-tags"
5560 },
5561 "remarks": "You can associate as many as 50 tags with a rule.\n\nTags 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) .\n\nTo be able to associate tags with a rule, you must have the `cloudwatch:TagResource` permission in addition to the `cloudwatch:PutInsightRule` permission.",
5562 "stability": "external",
5563 "summary": "A list of key-value pairs to associate with the Contributor Insights rule."
5564 },
5565 "immutable": true,
5566 "locationInModule": {
5567 "filename": "lib/cloudwatch.generated.ts",
5568 "line": 2497
5569 },
5570 "name": "tags",
5571 "optional": true,
5572 "type": {
5573 "union": {
5574 "types": [
5575 {
5576 "fqn": "@aws-cdk/core.IResolvable"
5577 },
5578 {
5579 "collection": {
5580 "elementtype": {
5581 "union": {
5582 "types": [
5583 {
5584 "fqn": "@aws-cdk/core.IResolvable"
5585 },
5586 {
5587 "fqn": "@aws-cdk/core.CfnTag"
5588 }
5589 ]
5590 }
5591 },
5592 "kind": "array"
5593 }
5594 }
5595 ]
5596 }
5597 }
5598 }
5599 ],
5600 "symbolId": "lib/cloudwatch.generated:CfnInsightRuleProps"
5601 },
5602 "@aws-cdk/aws-cloudwatch.CfnMetricStream": {
5603 "assembly": "@aws-cdk/aws-cloudwatch",
5604 "base": "@aws-cdk/core.CfnResource",
5605 "docs": {
5606 "custom": {
5607 "cloudformationResource": "AWS::CloudWatch::MetricStream",
5608 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html",
5609 "exampleMetadata": "fixture=_generated"
5610 },
5611 "remarks": "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) .\n\nTo 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.\n\nWhen you create or update a metric stream, you choose one of the following:\n\n- Stream metrics from all metric namespaces in the account.\n- Stream metrics from all metric namespaces in the account, except for the namespaces that you list in `ExcludeFilters` .\n- Stream metrics from only the metric namespaces that you list in `IncludeFilters` .\n\nWhen 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.",
5612 "stability": "external",
5613 "summary": "A CloudFormation `AWS::CloudWatch::MetricStream`.",
5614 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst cfnMetricStream = new cloudwatch.CfnMetricStream(this, 'MyCfnMetricStream', {\n firehoseArn: 'firehoseArn',\n outputFormat: 'outputFormat',\n roleArn: 'roleArn',\n\n // the properties below are optional\n excludeFilters: [{\n namespace: 'namespace',\n }],\n includeFilters: [{\n namespace: 'namespace',\n }],\n name: 'name',\n statisticsConfigurations: [{\n additionalStatistics: ['additionalStatistics'],\n includeMetrics: [{\n metricName: 'metricName',\n namespace: 'namespace',\n }],\n }],\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});"
5615 },
5616 "fqn": "@aws-cdk/aws-cloudwatch.CfnMetricStream",
5617 "initializer": {
5618 "docs": {
5619 "stability": "external",
5620 "summary": "Create a new `AWS::CloudWatch::MetricStream`."
5621 },
5622 "locationInModule": {
5623 "filename": "lib/cloudwatch.generated.ts",
5624 "line": 2974
5625 },
5626 "parameters": [
5627 {
5628 "docs": {
5629 "summary": "- scope in which this resource is defined."
5630 },
5631 "name": "scope",
5632 "type": {
5633 "fqn": "@aws-cdk/core.Construct"
5634 }
5635 },
5636 {
5637 "docs": {
5638 "summary": "- scoped id of the resource."
5639 },
5640 "name": "id",
5641 "type": {
5642 "primitive": "string"
5643 }
5644 },
5645 {
5646 "docs": {
5647 "summary": "- resource properties."
5648 },
5649 "name": "props",
5650 "type": {
5651 "fqn": "@aws-cdk/aws-cloudwatch.CfnMetricStreamProps"
5652 }
5653 }
5654 ]
5655 },
5656 "interfaces": [
5657 "@aws-cdk/core.IInspectable"
5658 ],
5659 "kind": "class",
5660 "locationInModule": {
5661 "filename": "lib/cloudwatch.generated.ts",
5662 "line": 2850
5663 },
5664 "methods": [
5665 {
5666 "docs": {
5667 "stability": "external",
5668 "summary": "Examines the CloudFormation resource and discloses attributes."
5669 },
5670 "locationInModule": {
5671 "filename": "lib/cloudwatch.generated.ts",
5672 "line": 3000
5673 },
5674 "name": "inspect",
5675 "overrides": "@aws-cdk/core.IInspectable",
5676 "parameters": [
5677 {
5678 "docs": {
5679 "summary": "- tree inspector to collect and process attributes."
5680 },
5681 "name": "inspector",
5682 "type": {
5683 "fqn": "@aws-cdk/core.TreeInspector"
5684 }
5685 }
5686 ]
5687 },
5688 {
5689 "docs": {
5690 "stability": "external"
5691 },
5692 "locationInModule": {
5693 "filename": "lib/cloudwatch.generated.ts",
5694 "line": 3018
5695 },
5696 "name": "renderProperties",
5697 "overrides": "@aws-cdk/core.CfnResource",
5698 "parameters": [
5699 {
5700 "name": "props",
5701 "type": {
5702 "collection": {
5703 "elementtype": {
5704 "primitive": "any"
5705 },
5706 "kind": "map"
5707 }
5708 }
5709 }
5710 ],
5711 "protected": true,
5712 "returns": {
5713 "type": {
5714 "collection": {
5715 "elementtype": {
5716 "primitive": "any"
5717 },
5718 "kind": "map"
5719 }
5720 }
5721 }
5722 }
5723 ],
5724 "name": "CfnMetricStream",
5725 "properties": [
5726 {
5727 "const": true,
5728 "docs": {
5729 "stability": "external",
5730 "summary": "The CloudFormation resource type name for this resource class."
5731 },
5732 "immutable": true,
5733 "locationInModule": {
5734 "filename": "lib/cloudwatch.generated.ts",
5735 "line": 2854
5736 },
5737 "name": "CFN_RESOURCE_TYPE_NAME",
5738 "static": true,
5739 "type": {
5740 "primitive": "string"
5741 }
5742 },
5743 {
5744 "docs": {
5745 "custom": {
5746 "cloudformationAttribute": "Arn"
5747 },
5748 "stability": "external",
5749 "summary": "The ARN of the metric stream."
5750 },
5751 "immutable": true,
5752 "locationInModule": {
5753 "filename": "lib/cloudwatch.generated.ts",
5754 "line": 2879
5755 },
5756 "name": "attrArn",
5757 "type": {
5758 "primitive": "string"
5759 }
5760 },
5761 {
5762 "docs": {
5763 "custom": {
5764 "cloudformationAttribute": "CreationDate"
5765 },
5766 "stability": "external",
5767 "summary": "The date that the metric stream was originally created."
5768 },
5769 "immutable": true,
5770 "locationInModule": {
5771 "filename": "lib/cloudwatch.generated.ts",
5772 "line": 2885
5773 },
5774 "name": "attrCreationDate",
5775 "type": {
5776 "primitive": "string"
5777 }
5778 },
5779 {
5780 "docs": {
5781 "custom": {
5782 "cloudformationAttribute": "LastUpdateDate"
5783 },
5784 "stability": "external",
5785 "summary": "The date that the metric stream was most recently updated."
5786 },
5787 "immutable": true,
5788 "locationInModule": {
5789 "filename": "lib/cloudwatch.generated.ts",
5790 "line": 2891
5791 },
5792 "name": "attrLastUpdateDate",
5793 "type": {
5794 "primitive": "string"
5795 }
5796 },
5797 {
5798 "docs": {
5799 "custom": {
5800 "cloudformationAttribute": "State"
5801 },
5802 "stability": "external",
5803 "summary": "The state of the metric stream, either `running` or `stopped` ."
5804 },
5805 "immutable": true,
5806 "locationInModule": {
5807 "filename": "lib/cloudwatch.generated.ts",
5808 "line": 2897
5809 },
5810 "name": "attrState",
5811 "type": {
5812 "primitive": "string"
5813 }
5814 },
5815 {
5816 "docs": {
5817 "stability": "external"
5818 },
5819 "immutable": true,
5820 "locationInModule": {
5821 "filename": "lib/cloudwatch.generated.ts",
5822 "line": 3005
5823 },
5824 "name": "cfnProperties",
5825 "overrides": "@aws-cdk/core.CfnResource",
5826 "protected": true,
5827 "type": {
5828 "collection": {
5829 "elementtype": {
5830 "primitive": "any"
5831 },
5832 "kind": "map"
5833 }
5834 }
5835 },
5836 {
5837 "docs": {
5838 "custom": {
5839 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-tags"
5840 },
5841 "remarks": "For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .",
5842 "stability": "external",
5843 "summary": "An array of key-value pairs to apply to the metric stream."
5844 },
5845 "immutable": true,
5846 "locationInModule": {
5847 "filename": "lib/cloudwatch.generated.ts",
5848 "line": 2965
5849 },
5850 "name": "tags",
5851 "type": {
5852 "fqn": "@aws-cdk/core.TagManager"
5853 }
5854 },
5855 {
5856 "docs": {
5857 "custom": {
5858 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-firehosearn"
5859 },
5860 "remarks": "This Amazon Kinesis Firehose delivery stream must already exist and must be in the same account as the metric stream.",
5861 "stability": "external",
5862 "summary": "The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream."
5863 },
5864 "locationInModule": {
5865 "filename": "lib/cloudwatch.generated.ts",
5866 "line": 2904
5867 },
5868 "name": "firehoseArn",
5869 "type": {
5870 "primitive": "string"
5871 }
5872 },
5873 {
5874 "docs": {
5875 "custom": {
5876 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-outputformat"
5877 },
5878 "remarks": "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) .\n\nThis parameter is required.",
5879 "stability": "external",
5880 "summary": "The output format for the stream."
5881 },
5882 "locationInModule": {
5883 "filename": "lib/cloudwatch.generated.ts",
5884 "line": 2913
5885 },
5886 "name": "outputFormat",
5887 "type": {
5888 "primitive": "string"
5889 }
5890 },
5891 {
5892 "docs": {
5893 "custom": {
5894 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-rolearn"
5895 },
5896 "remarks": "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.",
5897 "stability": "external",
5898 "summary": "The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources."
5899 },
5900 "locationInModule": {
5901 "filename": "lib/cloudwatch.generated.ts",
5902 "line": 2920
5903 },
5904 "name": "roleArn",
5905 "type": {
5906 "primitive": "string"
5907 }
5908 },
5909 {
5910 "docs": {
5911 "custom": {
5912 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-excludefilters"
5913 },
5914 "remarks": "You cannot specify both `IncludeFilters` and `ExcludeFilters` in the same metric stream.\n\nWhen 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.",
5915 "stability": "external",
5916 "summary": "If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here."
5917 },
5918 "locationInModule": {
5919 "filename": "lib/cloudwatch.generated.ts",
5920 "line": 2929
5921 },
5922 "name": "excludeFilters",
5923 "optional": true,
5924 "type": {
5925 "union": {
5926 "types": [
5927 {
5928 "fqn": "@aws-cdk/core.IResolvable"
5929 },
5930 {
5931 "collection": {
5932 "elementtype": {
5933 "union": {
5934 "types": [
5935 {
5936 "fqn": "@aws-cdk/core.IResolvable"
5937 },
5938 {
5939 "fqn": "@aws-cdk/aws-cloudwatch.CfnMetricStream.MetricStreamFilterProperty"
5940 }
5941 ]
5942 }
5943 },
5944 "kind": "array"
5945 }
5946 }
5947 ]
5948 }
5949 }
5950 },
5951 {
5952 "docs": {
5953 "custom": {
5954 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-includefilters"
5955 },
5956 "remarks": "You cannot specify both `IncludeFilters` and `ExcludeFilters` in the same metric stream.\n\nWhen 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.",
5957 "stability": "external",
5958 "summary": "If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here."
5959 },
5960 "locationInModule": {
5961 "filename": "lib/cloudwatch.generated.ts",
5962 "line": 2938
5963 },
5964 "name": "includeFilters",
5965 "optional": true,
5966 "type": {
5967 "union": {
5968 "types": [
5969 {
5970 "fqn": "@aws-cdk/core.IResolvable"
5971 },
5972 {
5973 "collection": {
5974 "elementtype": {
5975 "union": {
5976 "types": [
5977 {
5978 "fqn": "@aws-cdk/core.IResolvable"
5979 },
5980 {
5981 "fqn": "@aws-cdk/aws-cloudwatch.CfnMetricStream.MetricStreamFilterProperty"
5982 }
5983 ]
5984 }
5985 },
5986 "kind": "array"
5987 }
5988 }
5989 ]
5990 }
5991 }
5992 },
5993 {
5994 "docs": {
5995 "custom": {
5996 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-name"
5997 },
5998 "remarks": "The name must be different than the names of other metric streams in this account and Region.\n\nIf you are updating a metric stream, specify the name of that stream here.",
5999 "stability": "external",
6000 "summary": "If you are creating a new metric stream, this is the name for the new stream."
6001 },
6002 "locationInModule": {
6003 "filename": "lib/cloudwatch.generated.ts",
6004 "line": 2947
6005 },
6006 "name": "name",
6007 "optional": true,
6008 "type": {
6009 "primitive": "string"
6010 }
6011 },
6012 {
6013 "docs": {
6014 "custom": {
6015 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-statisticsconfigurations"
6016 },
6017 "remarks": "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.\n\nFor 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??)* .",
6018 "stability": "external",
6019 "summary": "By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed."
6020 },
6021 "locationInModule": {
6022 "filename": "lib/cloudwatch.generated.ts",
6023 "line": 2956
6024 },
6025 "name": "statisticsConfigurations",
6026 "optional": true,
6027 "type": {
6028 "union": {
6029 "types": [
6030 {
6031 "fqn": "@aws-cdk/core.IResolvable"
6032 },
6033 {
6034 "collection": {
6035 "elementtype": {
6036 "union": {
6037 "types": [
6038 {
6039 "fqn": "@aws-cdk/core.IResolvable"
6040 },
6041 {
6042 "fqn": "@aws-cdk/aws-cloudwatch.CfnMetricStream.MetricStreamStatisticsConfigurationProperty"
6043 }
6044 ]
6045 }
6046 },
6047 "kind": "array"
6048 }
6049 }
6050 ]
6051 }
6052 }
6053 }
6054 ],
6055 "symbolId": "lib/cloudwatch.generated:CfnMetricStream"
6056 },
6057 "@aws-cdk/aws-cloudwatch.CfnMetricStream.MetricStreamFilterProperty": {
6058 "assembly": "@aws-cdk/aws-cloudwatch",
6059 "datatype": true,
6060 "docs": {
6061 "custom": {
6062 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamfilter.html",
6063 "exampleMetadata": "fixture=_generated"
6064 },
6065 "stability": "external",
6066 "summary": "This structure contains the name of one of the metric namespaces that is listed in a filter of a metric stream.",
6067 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst metricStreamFilterProperty: cloudwatch.CfnMetricStream.MetricStreamFilterProperty = {\n namespace: 'namespace',\n};"
6068 },
6069 "fqn": "@aws-cdk/aws-cloudwatch.CfnMetricStream.MetricStreamFilterProperty",
6070 "kind": "interface",
6071 "locationInModule": {
6072 "filename": "lib/cloudwatch.generated.ts",
6073 "line": 3032
6074 },
6075 "name": "MetricStreamFilterProperty",
6076 "namespace": "CfnMetricStream",
6077 "properties": [
6078 {
6079 "abstract": true,
6080 "docs": {
6081 "custom": {
6082 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamfilter.html#cfn-cloudwatch-metricstream-metricstreamfilter-namespace"
6083 },
6084 "stability": "external",
6085 "summary": "The name of the metric namespace in the filter."
6086 },
6087 "immutable": true,
6088 "locationInModule": {
6089 "filename": "lib/cloudwatch.generated.ts",
6090 "line": 3038
6091 },
6092 "name": "namespace",
6093 "type": {
6094 "primitive": "string"
6095 }
6096 }
6097 ],
6098 "symbolId": "lib/cloudwatch.generated:CfnMetricStream.MetricStreamFilterProperty"
6099 },
6100 "@aws-cdk/aws-cloudwatch.CfnMetricStream.MetricStreamStatisticsConfigurationProperty": {
6101 "assembly": "@aws-cdk/aws-cloudwatch",
6102 "datatype": true,
6103 "docs": {
6104 "custom": {
6105 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsconfiguration.html",
6106 "exampleMetadata": "fixture=_generated"
6107 },
6108 "remarks": "All metrics that match the combination of metric name and namespace will be streamed with the additional statistics, no matter their dimensions.",
6109 "stability": "external",
6110 "summary": "This structure specifies a list of additional statistics to stream, and the metrics to stream those additional statistics for.",
6111 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst metricStreamStatisticsConfigurationProperty: cloudwatch.CfnMetricStream.MetricStreamStatisticsConfigurationProperty = {\n additionalStatistics: ['additionalStatistics'],\n includeMetrics: [{\n metricName: 'metricName',\n namespace: 'namespace',\n }],\n};"
6112 },
6113 "fqn": "@aws-cdk/aws-cloudwatch.CfnMetricStream.MetricStreamStatisticsConfigurationProperty",
6114 "kind": "interface",
6115 "locationInModule": {
6116 "filename": "lib/cloudwatch.generated.ts",
6117 "line": 3102
6118 },
6119 "name": "MetricStreamStatisticsConfigurationProperty",
6120 "namespace": "CfnMetricStream",
6121 "properties": [
6122 {
6123 "abstract": true,
6124 "docs": {
6125 "custom": {
6126 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsconfiguration.html#cfn-cloudwatch-metricstream-metricstreamstatisticsconfiguration-additionalstatistics"
6127 },
6128 "stability": "external",
6129 "summary": "The additional statistics to stream for the metrics listed in `IncludeMetrics` ."
6130 },
6131 "immutable": true,
6132 "locationInModule": {
6133 "filename": "lib/cloudwatch.generated.ts",
6134 "line": 3108
6135 },
6136 "name": "additionalStatistics",
6137 "type": {
6138 "collection": {
6139 "elementtype": {
6140 "primitive": "string"
6141 },
6142 "kind": "array"
6143 }
6144 }
6145 },
6146 {
6147 "abstract": true,
6148 "docs": {
6149 "custom": {
6150 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsconfiguration.html#cfn-cloudwatch-metricstream-metricstreamstatisticsconfiguration-includemetrics"
6151 },
6152 "stability": "external",
6153 "summary": "An array that defines the metrics that are to have additional statistics streamed."
6154 },
6155 "immutable": true,
6156 "locationInModule": {
6157 "filename": "lib/cloudwatch.generated.ts",
6158 "line": 3114
6159 },
6160 "name": "includeMetrics",
6161 "type": {
6162 "union": {
6163 "types": [
6164 {
6165 "fqn": "@aws-cdk/core.IResolvable"
6166 },
6167 {
6168 "collection": {
6169 "elementtype": {
6170 "union": {
6171 "types": [
6172 {
6173 "fqn": "@aws-cdk/core.IResolvable"
6174 },
6175 {
6176 "fqn": "@aws-cdk/aws-cloudwatch.CfnMetricStream.MetricStreamStatisticsMetricProperty"
6177 }
6178 ]
6179 }
6180 },
6181 "kind": "array"
6182 }
6183 }
6184 ]
6185 }
6186 }
6187 }
6188 ],
6189 "symbolId": "lib/cloudwatch.generated:CfnMetricStream.MetricStreamStatisticsConfigurationProperty"
6190 },
6191 "@aws-cdk/aws-cloudwatch.CfnMetricStream.MetricStreamStatisticsMetricProperty": {
6192 "assembly": "@aws-cdk/aws-cloudwatch",
6193 "datatype": true,
6194 "docs": {
6195 "custom": {
6196 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsmetric.html",
6197 "exampleMetadata": "fixture=_generated"
6198 },
6199 "stability": "external",
6200 "summary": "A structure that specifies the metric name and namespace for one metric that is going to have additional statistics included in the stream.",
6201 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst metricStreamStatisticsMetricProperty: cloudwatch.CfnMetricStream.MetricStreamStatisticsMetricProperty = {\n metricName: 'metricName',\n namespace: 'namespace',\n};"
6202 },
6203 "fqn": "@aws-cdk/aws-cloudwatch.CfnMetricStream.MetricStreamStatisticsMetricProperty",
6204 "kind": "interface",
6205 "locationInModule": {
6206 "filename": "lib/cloudwatch.generated.ts",
6207 "line": 3180
6208 },
6209 "name": "MetricStreamStatisticsMetricProperty",
6210 "namespace": "CfnMetricStream",
6211 "properties": [
6212 {
6213 "abstract": true,
6214 "docs": {
6215 "custom": {
6216 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsmetric.html#cfn-cloudwatch-metricstream-metricstreamstatisticsmetric-metricname"
6217 },
6218 "stability": "external",
6219 "summary": "The name of the metric."
6220 },
6221 "immutable": true,
6222 "locationInModule": {
6223 "filename": "lib/cloudwatch.generated.ts",
6224 "line": 3186
6225 },
6226 "name": "metricName",
6227 "type": {
6228 "primitive": "string"
6229 }
6230 },
6231 {
6232 "abstract": true,
6233 "docs": {
6234 "custom": {
6235 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsmetric.html#cfn-cloudwatch-metricstream-metricstreamstatisticsmetric-namespace"
6236 },
6237 "stability": "external",
6238 "summary": "The namespace of the metric."
6239 },
6240 "immutable": true,
6241 "locationInModule": {
6242 "filename": "lib/cloudwatch.generated.ts",
6243 "line": 3192
6244 },
6245 "name": "namespace",
6246 "type": {
6247 "primitive": "string"
6248 }
6249 }
6250 ],
6251 "symbolId": "lib/cloudwatch.generated:CfnMetricStream.MetricStreamStatisticsMetricProperty"
6252 },
6253 "@aws-cdk/aws-cloudwatch.CfnMetricStreamProps": {
6254 "assembly": "@aws-cdk/aws-cloudwatch",
6255 "datatype": true,
6256 "docs": {
6257 "custom": {
6258 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html",
6259 "exampleMetadata": "fixture=_generated"
6260 },
6261 "stability": "external",
6262 "summary": "Properties for defining a `CfnMetricStream`.",
6263 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst cfnMetricStreamProps: cloudwatch.CfnMetricStreamProps = {\n firehoseArn: 'firehoseArn',\n outputFormat: 'outputFormat',\n roleArn: 'roleArn',\n\n // the properties below are optional\n excludeFilters: [{\n namespace: 'namespace',\n }],\n includeFilters: [{\n namespace: 'namespace',\n }],\n name: 'name',\n statisticsConfigurations: [{\n additionalStatistics: ['additionalStatistics'],\n includeMetrics: [{\n metricName: 'metricName',\n namespace: 'namespace',\n }],\n }],\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};"
6264 },
6265 "fqn": "@aws-cdk/aws-cloudwatch.CfnMetricStreamProps",
6266 "kind": "interface",
6267 "locationInModule": {
6268 "filename": "lib/cloudwatch.generated.ts",
6269 "line": 2690
6270 },
6271 "name": "CfnMetricStreamProps",
6272 "properties": [
6273 {
6274 "abstract": true,
6275 "docs": {
6276 "custom": {
6277 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-firehosearn"
6278 },
6279 "remarks": "This Amazon Kinesis Firehose delivery stream must already exist and must be in the same account as the metric stream.",
6280 "stability": "external",
6281 "summary": "The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream."
6282 },
6283 "immutable": true,
6284 "locationInModule": {
6285 "filename": "lib/cloudwatch.generated.ts",
6286 "line": 2697
6287 },
6288 "name": "firehoseArn",
6289 "type": {
6290 "primitive": "string"
6291 }
6292 },
6293 {
6294 "abstract": true,
6295 "docs": {
6296 "custom": {
6297 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-outputformat"
6298 },
6299 "remarks": "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) .\n\nThis parameter is required.",
6300 "stability": "external",
6301 "summary": "The output format for the stream."
6302 },
6303 "immutable": true,
6304 "locationInModule": {
6305 "filename": "lib/cloudwatch.generated.ts",
6306 "line": 2706
6307 },
6308 "name": "outputFormat",
6309 "type": {
6310 "primitive": "string"
6311 }
6312 },
6313 {
6314 "abstract": true,
6315 "docs": {
6316 "custom": {
6317 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-rolearn"
6318 },
6319 "remarks": "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.",
6320 "stability": "external",
6321 "summary": "The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources."
6322 },
6323 "immutable": true,
6324 "locationInModule": {
6325 "filename": "lib/cloudwatch.generated.ts",
6326 "line": 2713
6327 },
6328 "name": "roleArn",
6329 "type": {
6330 "primitive": "string"
6331 }
6332 },
6333 {
6334 "abstract": true,
6335 "docs": {
6336 "custom": {
6337 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-excludefilters"
6338 },
6339 "remarks": "You cannot specify both `IncludeFilters` and `ExcludeFilters` in the same metric stream.\n\nWhen 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.",
6340 "stability": "external",
6341 "summary": "If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here."
6342 },
6343 "immutable": true,
6344 "locationInModule": {
6345 "filename": "lib/cloudwatch.generated.ts",
6346 "line": 2722
6347 },
6348 "name": "excludeFilters",
6349 "optional": true,
6350 "type": {
6351 "union": {
6352 "types": [
6353 {
6354 "fqn": "@aws-cdk/core.IResolvable"
6355 },
6356 {
6357 "collection": {
6358 "elementtype": {
6359 "union": {
6360 "types": [
6361 {
6362 "fqn": "@aws-cdk/core.IResolvable"
6363 },
6364 {
6365 "fqn": "@aws-cdk/aws-cloudwatch.CfnMetricStream.MetricStreamFilterProperty"
6366 }
6367 ]
6368 }
6369 },
6370 "kind": "array"
6371 }
6372 }
6373 ]
6374 }
6375 }
6376 },
6377 {
6378 "abstract": true,
6379 "docs": {
6380 "custom": {
6381 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-includefilters"
6382 },
6383 "remarks": "You cannot specify both `IncludeFilters` and `ExcludeFilters` in the same metric stream.\n\nWhen 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.",
6384 "stability": "external",
6385 "summary": "If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here."
6386 },
6387 "immutable": true,
6388 "locationInModule": {
6389 "filename": "lib/cloudwatch.generated.ts",
6390 "line": 2731
6391 },
6392 "name": "includeFilters",
6393 "optional": true,
6394 "type": {
6395 "union": {
6396 "types": [
6397 {
6398 "fqn": "@aws-cdk/core.IResolvable"
6399 },
6400 {
6401 "collection": {
6402 "elementtype": {
6403 "union": {
6404 "types": [
6405 {
6406 "fqn": "@aws-cdk/core.IResolvable"
6407 },
6408 {
6409 "fqn": "@aws-cdk/aws-cloudwatch.CfnMetricStream.MetricStreamFilterProperty"
6410 }
6411 ]
6412 }
6413 },
6414 "kind": "array"
6415 }
6416 }
6417 ]
6418 }
6419 }
6420 },
6421 {
6422 "abstract": true,
6423 "docs": {
6424 "custom": {
6425 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-name"
6426 },
6427 "remarks": "The name must be different than the names of other metric streams in this account and Region.\n\nIf you are updating a metric stream, specify the name of that stream here.",
6428 "stability": "external",
6429 "summary": "If you are creating a new metric stream, this is the name for the new stream."
6430 },
6431 "immutable": true,
6432 "locationInModule": {
6433 "filename": "lib/cloudwatch.generated.ts",
6434 "line": 2740
6435 },
6436 "name": "name",
6437 "optional": true,
6438 "type": {
6439 "primitive": "string"
6440 }
6441 },
6442 {
6443 "abstract": true,
6444 "docs": {
6445 "custom": {
6446 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-statisticsconfigurations"
6447 },
6448 "remarks": "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.\n\nFor 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??)* .",
6449 "stability": "external",
6450 "summary": "By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed."
6451 },
6452 "immutable": true,
6453 "locationInModule": {
6454 "filename": "lib/cloudwatch.generated.ts",
6455 "line": 2749
6456 },
6457 "name": "statisticsConfigurations",
6458 "optional": true,
6459 "type": {
6460 "union": {
6461 "types": [
6462 {
6463 "fqn": "@aws-cdk/core.IResolvable"
6464 },
6465 {
6466 "collection": {
6467 "elementtype": {
6468 "union": {
6469 "types": [
6470 {
6471 "fqn": "@aws-cdk/core.IResolvable"
6472 },
6473 {
6474 "fqn": "@aws-cdk/aws-cloudwatch.CfnMetricStream.MetricStreamStatisticsConfigurationProperty"
6475 }
6476 ]
6477 }
6478 },
6479 "kind": "array"
6480 }
6481 }
6482 ]
6483 }
6484 }
6485 },
6486 {
6487 "abstract": true,
6488 "docs": {
6489 "custom": {
6490 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-tags"
6491 },
6492 "remarks": "For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .",
6493 "stability": "external",
6494 "summary": "An array of key-value pairs to apply to the metric stream."
6495 },
6496 "immutable": true,
6497 "locationInModule": {
6498 "filename": "lib/cloudwatch.generated.ts",
6499 "line": 2758
6500 },
6501 "name": "tags",
6502 "optional": true,
6503 "type": {
6504 "collection": {
6505 "elementtype": {
6506 "fqn": "@aws-cdk/core.CfnTag"
6507 },
6508 "kind": "array"
6509 }
6510 }
6511 }
6512 ],
6513 "symbolId": "lib/cloudwatch.generated:CfnMetricStreamProps"
6514 },
6515 "@aws-cdk/aws-cloudwatch.Color": {
6516 "assembly": "@aws-cdk/aws-cloudwatch",
6517 "docs": {
6518 "custom": {
6519 "exampleMetadata": "infused"
6520 },
6521 "example": "declare const dashboard: cloudwatch.Dashboard;\ndeclare const executionCountMetric: cloudwatch.Metric;\ndeclare const errorCountMetric: cloudwatch.Metric;\n\ndashboard.addWidgets(new cloudwatch.GraphWidget({\n title: \"Executions vs error rate\",\n\n left: [executionCountMetric],\n\n right: [errorCountMetric.with({\n statistic: \"average\",\n label: \"Error rate\",\n color: cloudwatch.Color.GREEN,\n })]\n}));",
6522 "stability": "stable",
6523 "summary": "A set of standard colours that can be used in annotations in a GraphWidget."
6524 },
6525 "fqn": "@aws-cdk/aws-cloudwatch.Color",
6526 "kind": "class",
6527 "locationInModule": {
6528 "filename": "lib/graph.ts",
6529 "line": 524
6530 },
6531 "name": "Color",
6532 "properties": [
6533 {
6534 "const": true,
6535 "docs": {
6536 "stability": "stable",
6537 "summary": "blue - hex #1f77b4."
6538 },
6539 "immutable": true,
6540 "locationInModule": {
6541 "filename": "lib/graph.ts",
6542 "line": 526
6543 },
6544 "name": "BLUE",
6545 "static": true,
6546 "type": {
6547 "primitive": "string"
6548 }
6549 },
6550 {
6551 "const": true,
6552 "docs": {
6553 "stability": "stable",
6554 "summary": "brown - hex #8c564b."
6555 },
6556 "immutable": true,
6557 "locationInModule": {
6558 "filename": "lib/graph.ts",
6559 "line": 529
6560 },
6561 "name": "BROWN",
6562 "static": true,
6563 "type": {
6564 "primitive": "string"
6565 }
6566 },
6567 {
6568 "const": true,
6569 "docs": {
6570 "stability": "stable",
6571 "summary": "green - hex #2ca02c."
6572 },
6573 "immutable": true,
6574 "locationInModule": {
6575 "filename": "lib/graph.ts",
6576 "line": 532
6577 },
6578 "name": "GREEN",
6579 "static": true,
6580 "type": {
6581 "primitive": "string"
6582 }
6583 },
6584 {
6585 "const": true,
6586 "docs": {
6587 "stability": "stable",
6588 "summary": "grey - hex #7f7f7f."
6589 },
6590 "immutable": true,
6591 "locationInModule": {
6592 "filename": "lib/graph.ts",
6593 "line": 535
6594 },
6595 "name": "GREY",
6596 "static": true,
6597 "type": {
6598 "primitive": "string"
6599 }
6600 },
6601 {
6602 "const": true,
6603 "docs": {
6604 "stability": "stable",
6605 "summary": "orange - hex #ff7f0e."
6606 },
6607 "immutable": true,
6608 "locationInModule": {
6609 "filename": "lib/graph.ts",
6610 "line": 538
6611 },
6612 "name": "ORANGE",
6613 "static": true,
6614 "type": {
6615 "primitive": "string"
6616 }
6617 },
6618 {
6619 "const": true,
6620 "docs": {
6621 "stability": "stable",
6622 "summary": "pink - hex #e377c2."
6623 },
6624 "immutable": true,
6625 "locationInModule": {
6626 "filename": "lib/graph.ts",
6627 "line": 541
6628 },
6629 "name": "PINK",
6630 "static": true,
6631 "type": {
6632 "primitive": "string"
6633 }
6634 },
6635 {
6636 "const": true,
6637 "docs": {
6638 "stability": "stable",
6639 "summary": "purple - hex #9467bd."
6640 },
6641 "immutable": true,
6642 "locationInModule": {
6643 "filename": "lib/graph.ts",
6644 "line": 544
6645 },
6646 "name": "PURPLE",
6647 "static": true,
6648 "type": {
6649 "primitive": "string"
6650 }
6651 },
6652 {
6653 "const": true,
6654 "docs": {
6655 "stability": "stable",
6656 "summary": "red - hex #d62728."
6657 },
6658 "immutable": true,
6659 "locationInModule": {
6660 "filename": "lib/graph.ts",
6661 "line": 547
6662 },
6663 "name": "RED",
6664 "static": true,
6665 "type": {
6666 "primitive": "string"
6667 }
6668 }
6669 ],
6670 "symbolId": "lib/graph:Color"
6671 },
6672 "@aws-cdk/aws-cloudwatch.Column": {
6673 "assembly": "@aws-cdk/aws-cloudwatch",
6674 "docs": {
6675 "remarks": "Widgets will be laid out next to each other",
6676 "stability": "stable",
6677 "summary": "A widget that contains other widgets in a vertical column.",
6678 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\n\ndeclare const widget: cloudwatch.IWidget;\nconst column = new cloudwatch.Column(widget);",
6679 "custom": {
6680 "exampleMetadata": "fixture=_generated"
6681 }
6682 },
6683 "fqn": "@aws-cdk/aws-cloudwatch.Column",
6684 "initializer": {
6685 "docs": {
6686 "stability": "stable"
6687 },
6688 "locationInModule": {
6689 "filename": "lib/layout.ts",
6690 "line": 75
6691 },
6692 "parameters": [
6693 {
6694 "name": "widgets",
6695 "type": {
6696 "fqn": "@aws-cdk/aws-cloudwatch.IWidget"
6697 },
6698 "variadic": true
6699 }
6700 ],
6701 "variadic": true
6702 },
6703 "interfaces": [
6704 "@aws-cdk/aws-cloudwatch.IWidget"
6705 ],
6706 "kind": "class",
6707 "locationInModule": {
6708 "filename": "lib/layout.ts",
6709 "line": 66
6710 },
6711 "methods": [
6712 {
6713 "docs": {
6714 "stability": "stable",
6715 "summary": "Place the widget at a given position."
6716 },
6717 "locationInModule": {
6718 "filename": "lib/layout.ts",
6719 "line": 83
6720 },
6721 "name": "position",
6722 "overrides": "@aws-cdk/aws-cloudwatch.IWidget",
6723 "parameters": [
6724 {
6725 "name": "x",
6726 "type": {
6727 "primitive": "number"
6728 }
6729 },
6730 {
6731 "name": "y",
6732 "type": {
6733 "primitive": "number"
6734 }
6735 }
6736 ]
6737 },
6738 {
6739 "docs": {
6740 "stability": "stable",
6741 "summary": "Return the widget JSON for use in the dashboard."
6742 },
6743 "locationInModule": {
6744 "filename": "lib/layout.ts",
6745 "line": 91
6746 },
6747 "name": "toJson",
6748 "overrides": "@aws-cdk/aws-cloudwatch.IWidget",
6749 "returns": {
6750 "type": {
6751 "collection": {
6752 "elementtype": {
6753 "primitive": "any"
6754 },
6755 "kind": "array"
6756 }
6757 }
6758 }
6759 }
6760 ],
6761 "name": "Column",
6762 "properties": [
6763 {
6764 "docs": {
6765 "stability": "stable",
6766 "summary": "The amount of vertical grid units the widget will take up."
6767 },
6768 "immutable": true,
6769 "locationInModule": {
6770 "filename": "lib/layout.ts",
6771 "line": 68
6772 },
6773 "name": "height",
6774 "overrides": "@aws-cdk/aws-cloudwatch.IWidget",
6775 "type": {
6776 "primitive": "number"
6777 }
6778 },
6779 {
6780 "docs": {
6781 "stability": "stable",
6782 "summary": "List of contained widgets."
6783 },
6784 "immutable": true,
6785 "locationInModule": {
6786 "filename": "lib/layout.ts",
6787 "line": 73
6788 },
6789 "name": "widgets",
6790 "type": {
6791 "collection": {
6792 "elementtype": {
6793 "fqn": "@aws-cdk/aws-cloudwatch.IWidget"
6794 },
6795 "kind": "array"
6796 }
6797 }
6798 },
6799 {
6800 "docs": {
6801 "stability": "stable",
6802 "summary": "The amount of horizontal grid units the widget will take up."
6803 },
6804 "immutable": true,
6805 "locationInModule": {
6806 "filename": "lib/layout.ts",
6807 "line": 67
6808 },
6809 "name": "width",
6810 "overrides": "@aws-cdk/aws-cloudwatch.IWidget",
6811 "type": {
6812 "primitive": "number"
6813 }
6814 }
6815 ],
6816 "symbolId": "lib/layout:Column"
6817 },
6818 "@aws-cdk/aws-cloudwatch.CommonMetricOptions": {
6819 "assembly": "@aws-cdk/aws-cloudwatch",
6820 "datatype": true,
6821 "docs": {
6822 "stability": "stable",
6823 "summary": "Options shared by most methods accepting metric options.",
6824 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const dimensions: any;\nconst commonMetricOptions: cloudwatch.CommonMetricOptions = {\n account: 'account',\n color: 'color',\n dimensions: {\n dimensionsKey: dimensions,\n },\n dimensionsMap: {\n dimensionsMapKey: 'dimensionsMap',\n },\n label: 'label',\n period: cdk.Duration.minutes(30),\n region: 'region',\n statistic: 'statistic',\n unit: cloudwatch.Unit.SECONDS,\n};",
6825 "custom": {
6826 "exampleMetadata": "fixture=_generated"
6827 }
6828 },
6829 "fqn": "@aws-cdk/aws-cloudwatch.CommonMetricOptions",
6830 "kind": "interface",
6831 "locationInModule": {
6832 "filename": "lib/metric.ts",
6833 "line": 20
6834 },
6835 "name": "CommonMetricOptions",
6836 "properties": [
6837 {
6838 "abstract": true,
6839 "docs": {
6840 "default": "- Deployment account.",
6841 "stability": "stable",
6842 "summary": "Account which this metric comes from."
6843 },
6844 "immutable": true,
6845 "locationInModule": {
6846 "filename": "lib/metric.ts",
6847 "line": 106
6848 },
6849 "name": "account",
6850 "optional": true,
6851 "type": {
6852 "primitive": "string"
6853 }
6854 },
6855 {
6856 "abstract": true,
6857 "docs": {
6858 "default": "- Automatic color",
6859 "stability": "stable",
6860 "summary": "The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The `Color` class has a set of standard colors that can be used here."
6861 },
6862 "immutable": true,
6863 "locationInModule": {
6864 "filename": "lib/metric.ts",
6865 "line": 99
6866 },
6867 "name": "color",
6868 "optional": true,
6869 "type": {
6870 "primitive": "string"
6871 }
6872 },
6873 {
6874 "abstract": true,
6875 "docs": {
6876 "default": "- No dimensions.",
6877 "deprecated": "Use 'dimensionsMap' instead.",
6878 "stability": "deprecated",
6879 "summary": "Dimensions of the metric."
6880 },
6881 "immutable": true,
6882 "locationInModule": {
6883 "filename": "lib/metric.ts",
6884 "line": 51
6885 },
6886 "name": "dimensions",
6887 "optional": true,
6888 "type": {
6889 "collection": {
6890 "elementtype": {
6891 "primitive": "any"
6892 },
6893 "kind": "map"
6894 }
6895 }
6896 },
6897 {
6898 "abstract": true,
6899 "docs": {
6900 "default": "- No dimensions.",
6901 "stability": "stable",
6902 "summary": "Dimensions of the metric."
6903 },
6904 "immutable": true,
6905 "locationInModule": {
6906 "filename": "lib/metric.ts",
6907 "line": 58
6908 },
6909 "name": "dimensionsMap",
6910 "optional": true,
6911 "type": {
6912 "collection": {
6913 "elementtype": {
6914 "primitive": "string"
6915 },
6916 "kind": "map"
6917 }
6918 }
6919 },
6920 {
6921 "abstract": true,
6922 "docs": {
6923 "default": "- No label",
6924 "remarks": "You can use [dynamic labels](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html)\nto show summary information about the entire displayed time series\nin the legend. For example, if you use:\n\n```\n[max: ${MAX}] MyMetric\n```\n\nAs the metric label, the maximum value in the visible range will\nbe shown next to the time series name in the graph's legend.",
6925 "stability": "stable",
6926 "summary": "Label for this metric when added to a Graph in a Dashboard."
6927 },
6928 "immutable": true,
6929 "locationInModule": {
6930 "filename": "lib/metric.ts",
6931 "line": 92
6932 },
6933 "name": "label",
6934 "optional": true,
6935 "type": {
6936 "primitive": "string"
6937 }
6938 },
6939 {
6940 "abstract": true,
6941 "docs": {
6942 "default": "Duration.minutes(5)",
6943 "stability": "stable",
6944 "summary": "The period over which the specified statistic is applied."
6945 },
6946 "immutable": true,
6947 "locationInModule": {
6948 "filename": "lib/metric.ts",
6949 "line": 26
6950 },
6951 "name": "period",
6952 "optional": true,
6953 "type": {
6954 "fqn": "@aws-cdk/core.Duration"
6955 }
6956 },
6957 {
6958 "abstract": true,
6959 "docs": {
6960 "default": "- Deployment region.",
6961 "stability": "stable",
6962 "summary": "Region which this metric comes from."
6963 },
6964 "immutable": true,
6965 "locationInModule": {
6966 "filename": "lib/metric.ts",
6967 "line": 113
6968 },
6969 "name": "region",
6970 "optional": true,
6971 "type": {
6972 "primitive": "string"
6973 }
6974 },
6975 {
6976 "abstract": true,
6977 "docs": {
6978 "default": "Average",
6979 "remarks": "Can be one of the following:\n\n- \"Minimum\" | \"min\"\n- \"Maximum\" | \"max\"\n- \"Average\" | \"avg\"\n- \"Sum\" | \"sum\"\n- \"SampleCount | \"n\"\n- \"pNN.NN\"",
6980 "stability": "stable",
6981 "summary": "What function to use for aggregating."
6982 },
6983 "immutable": true,
6984 "locationInModule": {
6985 "filename": "lib/metric.ts",
6986 "line": 42
6987 },
6988 "name": "statistic",
6989 "optional": true,
6990 "type": {
6991 "primitive": "string"
6992 }
6993 },
6994 {
6995 "abstract": true,
6996 "docs": {
6997 "default": "- All metric datums in the given metric stream",
6998 "remarks": "Only refer to datums emitted to the metric stream with the given unit and\nignore all others. Only useful when datums are being emitted to the same\nmetric stream under different units.\n\nThe default is to use all matric datums in the stream, regardless of unit,\nwhich is recommended in nearly all cases.\n\nCloudWatch does not honor this property for graphs.",
6999 "stability": "stable",
7000 "summary": "Unit used to filter the metric stream."
7001 },
7002 "immutable": true,
7003 "locationInModule": {
7004 "filename": "lib/metric.ts",
7005 "line": 74
7006 },
7007 "name": "unit",
7008 "optional": true,
7009 "type": {
7010 "fqn": "@aws-cdk/aws-cloudwatch.Unit"
7011 }
7012 }
7013 ],
7014 "symbolId": "lib/metric:CommonMetricOptions"
7015 },
7016 "@aws-cdk/aws-cloudwatch.ComparisonOperator": {
7017 "assembly": "@aws-cdk/aws-cloudwatch",
7018 "docs": {
7019 "custom": {
7020 "exampleMetadata": "infused"
7021 },
7022 "example": "import * as cloudwatch from '@aws-cdk/aws-cloudwatch';\n\ndeclare const myHostedZone: route53.HostedZone;\nconst certificate = new acm.Certificate(this, 'Certificate', {\n domainName: 'hello.example.com',\n validation: acm.CertificateValidation.fromDns(myHostedZone),\n});\ncertificate.metricDaysToExpiry().createAlarm(this, 'Alarm', {\n comparisonOperator: cloudwatch.ComparisonOperator.LESS_THAN_THRESHOLD,\n evaluationPeriods: 1,\n threshold: 45, // Automatic rotation happens between 60 and 45 days before expiry\n});",
7023 "stability": "stable",
7024 "summary": "Comparison operator for evaluating alarms."
7025 },
7026 "fqn": "@aws-cdk/aws-cloudwatch.ComparisonOperator",
7027 "kind": "enum",
7028 "locationInModule": {
7029 "filename": "lib/alarm.ts",
7030 "line": 30
7031 },
7032 "members": [
7033 {
7034 "docs": {
7035 "stability": "stable",
7036 "summary": "Specified statistic is greater than or equal to the threshold."
7037 },
7038 "name": "GREATER_THAN_OR_EQUAL_TO_THRESHOLD"
7039 },
7040 {
7041 "docs": {
7042 "stability": "stable",
7043 "summary": "Specified statistic is strictly greater than the threshold."
7044 },
7045 "name": "GREATER_THAN_THRESHOLD"
7046 },
7047 {
7048 "docs": {
7049 "stability": "stable",
7050 "summary": "Specified statistic is strictly less than the threshold."
7051 },
7052 "name": "LESS_THAN_THRESHOLD"
7053 },
7054 {
7055 "docs": {
7056 "stability": "stable",
7057 "summary": "Specified statistic is less than or equal to the threshold."
7058 },
7059 "name": "LESS_THAN_OR_EQUAL_TO_THRESHOLD"
7060 },
7061 {
7062 "docs": {
7063 "remarks": "Used only for alarms based on anomaly detection models",
7064 "stability": "stable",
7065 "summary": "Specified statistic is lower than or greater than the anomaly model band."
7066 },
7067 "name": "LESS_THAN_LOWER_OR_GREATER_THAN_UPPER_THRESHOLD"
7068 },
7069 {
7070 "docs": {
7071 "remarks": "Used only for alarms based on anomaly detection models",
7072 "stability": "stable",
7073 "summary": "Specified statistic is greater than the anomaly model band."
7074 },
7075 "name": "GREATER_THAN_UPPER_THRESHOLD"
7076 },
7077 {
7078 "docs": {
7079 "remarks": "Used only for alarms based on anomaly detection models",
7080 "stability": "stable",
7081 "summary": "Specified statistic is lower than the anomaly model band."
7082 },
7083 "name": "LESS_THAN_LOWER_THRESHOLD"
7084 }
7085 ],
7086 "name": "ComparisonOperator",
7087 "symbolId": "lib/alarm:ComparisonOperator"
7088 },
7089 "@aws-cdk/aws-cloudwatch.CompositeAlarm": {
7090 "assembly": "@aws-cdk/aws-cloudwatch",
7091 "base": "@aws-cdk/aws-cloudwatch.AlarmBase",
7092 "docs": {
7093 "custom": {
7094 "exampleMetadata": "infused"
7095 },
7096 "example": "declare const alarm1: cloudwatch.Alarm;\ndeclare const alarm2: cloudwatch.Alarm;\ndeclare const alarm3: cloudwatch.Alarm;\ndeclare const alarm4: cloudwatch.Alarm;\n\nconst alarmRule = cloudwatch.AlarmRule.anyOf(\n cloudwatch.AlarmRule.allOf(\n cloudwatch.AlarmRule.anyOf(\n alarm1,\n cloudwatch.AlarmRule.fromAlarm(alarm2, cloudwatch.AlarmState.OK),\n alarm3,\n ),\n cloudwatch.AlarmRule.not(cloudwatch.AlarmRule.fromAlarm(alarm4, cloudwatch.AlarmState.INSUFFICIENT_DATA)),\n ),\n cloudwatch.AlarmRule.fromBoolean(false),\n);\n\nnew cloudwatch.CompositeAlarm(this, 'MyAwesomeCompositeAlarm', {\n alarmRule,\n});",
7097 "stability": "stable",
7098 "summary": "A Composite Alarm based on Alarm Rule."
7099 },
7100 "fqn": "@aws-cdk/aws-cloudwatch.CompositeAlarm",
7101 "initializer": {
7102 "docs": {
7103 "stability": "stable"
7104 },
7105 "locationInModule": {
7106 "filename": "lib/composite-alarm.ts",
7107 "line": 92
7108 },
7109 "parameters": [
7110 {
7111 "name": "scope",
7112 "type": {
7113 "fqn": "constructs.Construct"
7114 }
7115 },
7116 {
7117 "name": "id",
7118 "type": {
7119 "primitive": "string"
7120 }
7121 },
7122 {
7123 "name": "props",
7124 "type": {
7125 "fqn": "@aws-cdk/aws-cloudwatch.CompositeAlarmProps"
7126 }
7127 }
7128 ]
7129 },
7130 "kind": "class",
7131 "locationInModule": {
7132 "filename": "lib/composite-alarm.ts",
7133 "line": 42
7134 },
7135 "methods": [
7136 {
7137 "docs": {
7138 "stability": "stable",
7139 "summary": "Import an existing CloudWatch composite alarm provided an ARN."
7140 },
7141 "locationInModule": {
7142 "filename": "lib/composite-alarm.ts",
7143 "line": 68
7144 },
7145 "name": "fromCompositeAlarmArn",
7146 "parameters": [
7147 {
7148 "docs": {
7149 "summary": "The parent creating construct (usually `this`)."
7150 },
7151 "name": "scope",
7152 "type": {
7153 "fqn": "constructs.Construct"
7154 }
7155 },
7156 {
7157 "docs": {
7158 "summary": "The construct's name."
7159 },
7160 "name": "id",
7161 "type": {
7162 "primitive": "string"
7163 }
7164 },
7165 {
7166 "docs": {
7167 "summary": "Composite Alarm ARN (i.e. arn:aws:cloudwatch:<region>:<account-id>:alarm/CompositeAlarmName)."
7168 },
7169 "name": "compositeAlarmArn",
7170 "type": {
7171 "primitive": "string"
7172 }
7173 }
7174 ],
7175 "returns": {
7176 "type": {
7177 "fqn": "@aws-cdk/aws-cloudwatch.IAlarm"
7178 }
7179 },
7180 "static": true
7181 },
7182 {
7183 "docs": {
7184 "stability": "stable",
7185 "summary": "Import an existing CloudWatch composite alarm provided an Name."
7186 },
7187 "locationInModule": {
7188 "filename": "lib/composite-alarm.ts",
7189 "line": 51
7190 },
7191 "name": "fromCompositeAlarmName",
7192 "parameters": [
7193 {
7194 "docs": {
7195 "summary": "The parent creating construct (usually `this`)."
7196 },
7197 "name": "scope",
7198 "type": {
7199 "fqn": "constructs.Construct"
7200 }
7201 },
7202 {
7203 "docs": {
7204 "summary": "The construct's name."
7205 },
7206 "name": "id",
7207 "type": {
7208 "primitive": "string"
7209 }
7210 },
7211 {
7212 "docs": {
7213 "summary": "Composite Alarm Name."
7214 },
7215 "name": "compositeAlarmName",
7216 "type": {
7217 "primitive": "string"
7218 }
7219 }
7220 ],
7221 "returns": {
7222 "type": {
7223 "fqn": "@aws-cdk/aws-cloudwatch.IAlarm"
7224 }
7225 },
7226 "static": true
7227 }
7228 ],
7229 "name": "CompositeAlarm",
7230 "properties": [
7231 {
7232 "docs": {
7233 "custom": {
7234 "attribute": "true"
7235 },
7236 "stability": "stable",
7237 "summary": "ARN of this alarm."
7238 },
7239 "immutable": true,
7240 "locationInModule": {
7241 "filename": "lib/composite-alarm.ts",
7242 "line": 81
7243 },
7244 "name": "alarmArn",
7245 "overrides": "@aws-cdk/aws-cloudwatch.AlarmBase",
7246 "type": {
7247 "primitive": "string"
7248 }
7249 },
7250 {
7251 "docs": {
7252 "custom": {
7253 "attribute": "true"
7254 },
7255 "stability": "stable",
7256 "summary": "Name of this alarm."
7257 },
7258 "immutable": true,
7259 "locationInModule": {
7260 "filename": "lib/composite-alarm.ts",
7261 "line": 88
7262 },
7263 "name": "alarmName",
7264 "overrides": "@aws-cdk/aws-cloudwatch.AlarmBase",
7265 "type": {
7266 "primitive": "string"
7267 }
7268 }
7269 ],
7270 "symbolId": "lib/composite-alarm:CompositeAlarm"
7271 },
7272 "@aws-cdk/aws-cloudwatch.CompositeAlarmProps": {
7273 "assembly": "@aws-cdk/aws-cloudwatch",
7274 "datatype": true,
7275 "docs": {
7276 "custom": {
7277 "exampleMetadata": "infused"
7278 },
7279 "example": "declare const alarm1: cloudwatch.Alarm;\ndeclare const alarm2: cloudwatch.Alarm;\ndeclare const alarm3: cloudwatch.Alarm;\ndeclare const alarm4: cloudwatch.Alarm;\n\nconst alarmRule = cloudwatch.AlarmRule.anyOf(\n cloudwatch.AlarmRule.allOf(\n cloudwatch.AlarmRule.anyOf(\n alarm1,\n cloudwatch.AlarmRule.fromAlarm(alarm2, cloudwatch.AlarmState.OK),\n alarm3,\n ),\n cloudwatch.AlarmRule.not(cloudwatch.AlarmRule.fromAlarm(alarm4, cloudwatch.AlarmState.INSUFFICIENT_DATA)),\n ),\n cloudwatch.AlarmRule.fromBoolean(false),\n);\n\nnew cloudwatch.CompositeAlarm(this, 'MyAwesomeCompositeAlarm', {\n alarmRule,\n});",
7280 "stability": "stable",
7281 "summary": "Properties for creating a Composite Alarm."
7282 },
7283 "fqn": "@aws-cdk/aws-cloudwatch.CompositeAlarmProps",
7284 "kind": "interface",
7285 "locationInModule": {
7286 "filename": "lib/composite-alarm.ts",
7287 "line": 9
7288 },
7289 "name": "CompositeAlarmProps",
7290 "properties": [
7291 {
7292 "abstract": true,
7293 "docs": {
7294 "stability": "stable",
7295 "summary": "Expression that specifies which other alarms are to be evaluated to determine this composite alarm's state."
7296 },
7297 "immutable": true,
7298 "locationInModule": {
7299 "filename": "lib/composite-alarm.ts",
7300 "line": 35
7301 },
7302 "name": "alarmRule",
7303 "type": {
7304 "fqn": "@aws-cdk/aws-cloudwatch.IAlarmRule"
7305 }
7306 },
7307 {
7308 "abstract": true,
7309 "docs": {
7310 "default": "true",
7311 "stability": "stable",
7312 "summary": "Whether the actions for this alarm are enabled."
7313 },
7314 "immutable": true,
7315 "locationInModule": {
7316 "filename": "lib/composite-alarm.ts",
7317 "line": 16
7318 },
7319 "name": "actionsEnabled",
7320 "optional": true,
7321 "type": {
7322 "primitive": "boolean"
7323 }
7324 },
7325 {
7326 "abstract": true,
7327 "docs": {
7328 "default": "No description",
7329 "stability": "stable",
7330 "summary": "Description for the alarm."
7331 },
7332 "immutable": true,
7333 "locationInModule": {
7334 "filename": "lib/composite-alarm.ts",
7335 "line": 23
7336 },
7337 "name": "alarmDescription",
7338 "optional": true,
7339 "type": {
7340 "primitive": "string"
7341 }
7342 },
7343 {
7344 "abstract": true,
7345 "docs": {
7346 "default": "Automatically generated name",
7347 "stability": "stable",
7348 "summary": "Name of the alarm."
7349 },
7350 "immutable": true,
7351 "locationInModule": {
7352 "filename": "lib/composite-alarm.ts",
7353 "line": 30
7354 },
7355 "name": "compositeAlarmName",
7356 "optional": true,
7357 "type": {
7358 "primitive": "string"
7359 }
7360 }
7361 ],
7362 "symbolId": "lib/composite-alarm:CompositeAlarmProps"
7363 },
7364 "@aws-cdk/aws-cloudwatch.ConcreteWidget": {
7365 "abstract": true,
7366 "assembly": "@aws-cdk/aws-cloudwatch",
7367 "docs": {
7368 "remarks": "This is in contrast to other widgets which exist for layout purposes.",
7369 "stability": "stable",
7370 "summary": "A real CloudWatch widget that has its own fixed size and remembers its position."
7371 },
7372 "fqn": "@aws-cdk/aws-cloudwatch.ConcreteWidget",
7373 "initializer": {
7374 "docs": {
7375 "stability": "stable"
7376 },
7377 "locationInModule": {
7378 "filename": "lib/widget.ts",
7379 "line": 51
7380 },
7381 "parameters": [
7382 {
7383 "name": "width",
7384 "type": {
7385 "primitive": "number"
7386 }
7387 },
7388 {
7389 "name": "height",
7390 "type": {
7391 "primitive": "number"
7392 }
7393 }
7394 ]
7395 },
7396 "interfaces": [
7397 "@aws-cdk/aws-cloudwatch.IWidget"
7398 ],
7399 "kind": "class",
7400 "locationInModule": {
7401 "filename": "lib/widget.ts",
7402 "line": 43
7403 },
7404 "methods": [
7405 {
7406 "docs": {
7407 "stability": "stable",
7408 "summary": "Copy the warnings from the given metric."
7409 },
7410 "locationInModule": {
7411 "filename": "lib/widget.ts",
7412 "line": 70
7413 },
7414 "name": "copyMetricWarnings",
7415 "parameters": [
7416 {
7417 "name": "ms",
7418 "type": {
7419 "fqn": "@aws-cdk/aws-cloudwatch.IMetric"
7420 },
7421 "variadic": true
7422 }
7423 ],
7424 "protected": true,
7425 "variadic": true
7426 },
7427 {
7428 "docs": {
7429 "stability": "stable",
7430 "summary": "Place the widget at a given position."
7431 },
7432 "locationInModule": {
7433 "filename": "lib/widget.ts",
7434 "line": 60
7435 },
7436 "name": "position",
7437 "overrides": "@aws-cdk/aws-cloudwatch.IWidget",
7438 "parameters": [
7439 {
7440 "name": "x",
7441 "type": {
7442 "primitive": "number"
7443 }
7444 },
7445 {
7446 "name": "y",
7447 "type": {
7448 "primitive": "number"
7449 }
7450 }
7451 ]
7452 },
7453 {
7454 "abstract": true,
7455 "docs": {
7456 "stability": "stable",
7457 "summary": "Return the widget JSON for use in the dashboard."
7458 },
7459 "locationInModule": {
7460 "filename": "lib/widget.ts",
7461 "line": 65
7462 },
7463 "name": "toJson",
7464 "overrides": "@aws-cdk/aws-cloudwatch.IWidget",
7465 "returns": {
7466 "type": {
7467 "collection": {
7468 "elementtype": {
7469 "primitive": "any"
7470 },
7471 "kind": "array"
7472 }
7473 }
7474 }
7475 }
7476 ],
7477 "name": "ConcreteWidget",
7478 "properties": [
7479 {
7480 "docs": {
7481 "stability": "stable",
7482 "summary": "The amount of vertical grid units the widget will take up."
7483 },
7484 "immutable": true,
7485 "locationInModule": {
7486 "filename": "lib/widget.ts",
7487 "line": 45
7488 },
7489 "name": "height",
7490 "overrides": "@aws-cdk/aws-cloudwatch.IWidget",
7491 "type": {
7492 "primitive": "number"
7493 }
7494 },
7495 {
7496 "docs": {
7497 "stability": "stable",
7498 "summary": "The amount of horizontal grid units the widget will take up."
7499 },
7500 "immutable": true,
7501 "locationInModule": {
7502 "filename": "lib/widget.ts",
7503 "line": 44
7504 },
7505 "name": "width",
7506 "overrides": "@aws-cdk/aws-cloudwatch.IWidget",
7507 "type": {
7508 "primitive": "number"
7509 }
7510 },
7511 {
7512 "docs": {
7513 "stability": "stable",
7514 "summary": "Any warnings that are produced as a result of putting together this widget."
7515 },
7516 "immutable": true,
7517 "locationInModule": {
7518 "filename": "lib/widget.ts",
7519 "line": 49
7520 },
7521 "name": "warnings",
7522 "optional": true,
7523 "overrides": "@aws-cdk/aws-cloudwatch.IWidget",
7524 "type": {
7525 "collection": {
7526 "elementtype": {
7527 "primitive": "string"
7528 },
7529 "kind": "array"
7530 }
7531 }
7532 },
7533 {
7534 "docs": {
7535 "stability": "stable"
7536 },
7537 "locationInModule": {
7538 "filename": "lib/widget.ts",
7539 "line": 46
7540 },
7541 "name": "x",
7542 "optional": true,
7543 "protected": true,
7544 "type": {
7545 "primitive": "number"
7546 }
7547 },
7548 {
7549 "docs": {
7550 "stability": "stable"
7551 },
7552 "locationInModule": {
7553 "filename": "lib/widget.ts",
7554 "line": 47
7555 },
7556 "name": "y",
7557 "optional": true,
7558 "protected": true,
7559 "type": {
7560 "primitive": "number"
7561 }
7562 }
7563 ],
7564 "symbolId": "lib/widget:ConcreteWidget"
7565 },
7566 "@aws-cdk/aws-cloudwatch.CreateAlarmOptions": {
7567 "assembly": "@aws-cdk/aws-cloudwatch",
7568 "datatype": true,
7569 "docs": {
7570 "custom": {
7571 "exampleMetadata": "infused"
7572 },
7573 "example": "declare const fn: lambda.Function;\n\nfn.metricErrors().createAlarm(this, 'Alarm', {\n threshold: 100,\n evaluationPeriods: 2,\n});",
7574 "stability": "stable",
7575 "summary": "Properties needed to make an alarm from a metric."
7576 },
7577 "fqn": "@aws-cdk/aws-cloudwatch.CreateAlarmOptions",
7578 "kind": "interface",
7579 "locationInModule": {
7580 "filename": "lib/metric.ts",
7581 "line": 734
7582 },
7583 "name": "CreateAlarmOptions",
7584 "properties": [
7585 {
7586 "abstract": true,
7587 "docs": {
7588 "stability": "stable",
7589 "summary": "The number of periods over which data is compared to the specified threshold."
7590 },
7591 "immutable": true,
7592 "locationInModule": {
7593 "filename": "lib/metric.ts",
7594 "line": 793
7595 },
7596 "name": "evaluationPeriods",
7597 "type": {
7598 "primitive": "number"
7599 }
7600 },
7601 {
7602 "abstract": true,
7603 "docs": {
7604 "stability": "stable",
7605 "summary": "The value against which the specified statistic is compared."
7606 },
7607 "immutable": true,
7608 "locationInModule": {
7609 "filename": "lib/metric.ts",
7610 "line": 788
7611 },
7612 "name": "threshold",
7613 "type": {
7614 "primitive": "number"
7615 }
7616 },
7617 {
7618 "abstract": true,
7619 "docs": {
7620 "default": "true",
7621 "stability": "stable",
7622 "summary": "Whether the actions for this alarm are enabled."
7623 },
7624 "immutable": true,
7625 "locationInModule": {
7626 "filename": "lib/metric.ts",
7627 "line": 816
7628 },
7629 "name": "actionsEnabled",
7630 "optional": true,
7631 "type": {
7632 "primitive": "boolean"
7633 }
7634 },
7635 {
7636 "abstract": true,
7637 "docs": {
7638 "default": "No description",
7639 "stability": "stable",
7640 "summary": "Description for the alarm."
7641 },
7642 "immutable": true,
7643 "locationInModule": {
7644 "filename": "lib/metric.ts",
7645 "line": 776
7646 },
7647 "name": "alarmDescription",
7648 "optional": true,
7649 "type": {
7650 "primitive": "string"
7651 }
7652 },
7653 {
7654 "abstract": true,
7655 "docs": {
7656 "default": "Automatically generated name",
7657 "stability": "stable",
7658 "summary": "Name of the alarm."
7659 },
7660 "immutable": true,
7661 "locationInModule": {
7662 "filename": "lib/metric.ts",
7663 "line": 769
7664 },
7665 "name": "alarmName",
7666 "optional": true,
7667 "type": {
7668 "primitive": "string"
7669 }
7670 },
7671 {
7672 "abstract": true,
7673 "docs": {
7674 "default": "GreaterThanOrEqualToThreshold",
7675 "stability": "stable",
7676 "summary": "Comparison to use to check if metric is breaching."
7677 },
7678 "immutable": true,
7679 "locationInModule": {
7680 "filename": "lib/metric.ts",
7681 "line": 783
7682 },
7683 "name": "comparisonOperator",
7684 "optional": true,
7685 "type": {
7686 "fqn": "@aws-cdk/aws-cloudwatch.ComparisonOperator"
7687 }
7688 },
7689 {
7690 "abstract": true,
7691 "docs": {
7692 "default": "``evaluationPeriods``",
7693 "remarks": "This is used only if you are setting an \"M\nout of N\" alarm. In that case, this value is the M. For more information, see Evaluating an Alarm in the Amazon\nCloudWatch User Guide.",
7694 "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation",
7695 "stability": "stable",
7696 "summary": "The number of datapoints that must be breaching to trigger the alarm."
7697 },
7698 "immutable": true,
7699 "locationInModule": {
7700 "filename": "lib/metric.ts",
7701 "line": 827
7702 },
7703 "name": "datapointsToAlarm",
7704 "optional": true,
7705 "type": {
7706 "primitive": "number"
7707 }
7708 },
7709 {
7710 "abstract": true,
7711 "docs": {
7712 "default": "- Not configured.",
7713 "remarks": "Used only for alarms that are based on percentiles.",
7714 "stability": "stable",
7715 "summary": "Specifies whether to evaluate the data and potentially change the alarm state if there are too few data points to be statistically significant."
7716 },
7717 "immutable": true,
7718 "locationInModule": {
7719 "filename": "lib/metric.ts",
7720 "line": 802
7721 },
7722 "name": "evaluateLowSampleCountPercentile",
7723 "optional": true,
7724 "type": {
7725 "primitive": "string"
7726 }
7727 },
7728 {
7729 "abstract": true,
7730 "docs": {
7731 "default": "- The period from the metric",
7732 "deprecated": "Use `metric.with({ period: ... })` to encode the period into the Metric object",
7733 "remarks": "Cannot be used with `MathExpression` objects.",
7734 "stability": "deprecated",
7735 "summary": "The period over which the specified statistic is applied."
7736 },
7737 "immutable": true,
7738 "locationInModule": {
7739 "filename": "lib/metric.ts",
7740 "line": 743
7741 },
7742 "name": "period",
7743 "optional": true,
7744 "type": {
7745 "fqn": "@aws-cdk/core.Duration"
7746 }
7747 },
7748 {
7749 "abstract": true,
7750 "docs": {
7751 "default": "- The statistic from the metric",
7752 "deprecated": "Use `metric.with({ statistic: ... })` to encode the period into the Metric object",
7753 "remarks": "Can be one of the following:\n\n- \"Minimum\" | \"min\"\n- \"Maximum\" | \"max\"\n- \"Average\" | \"avg\"\n- \"Sum\" | \"sum\"\n- \"SampleCount | \"n\"\n- \"pNN.NN\"\n\nCannot be used with `MathExpression` objects.",
7754 "stability": "deprecated",
7755 "summary": "What function to use for aggregating."
7756 },
7757 "immutable": true,
7758 "locationInModule": {
7759 "filename": "lib/metric.ts",
7760 "line": 762
7761 },
7762 "name": "statistic",
7763 "optional": true,
7764 "type": {
7765 "primitive": "string"
7766 }
7767 },
7768 {
7769 "abstract": true,
7770 "docs": {
7771 "default": "TreatMissingData.Missing",
7772 "stability": "stable",
7773 "summary": "Sets how this alarm is to handle missing data points."
7774 },
7775 "immutable": true,
7776 "locationInModule": {
7777 "filename": "lib/metric.ts",
7778 "line": 809
7779 },
7780 "name": "treatMissingData",
7781 "optional": true,
7782 "type": {
7783 "fqn": "@aws-cdk/aws-cloudwatch.TreatMissingData"
7784 }
7785 }
7786 ],
7787 "symbolId": "lib/metric:CreateAlarmOptions"
7788 },
7789 "@aws-cdk/aws-cloudwatch.CustomWidget": {
7790 "assembly": "@aws-cdk/aws-cloudwatch",
7791 "base": "@aws-cdk/aws-cloudwatch.ConcreteWidget",
7792 "docs": {
7793 "custom": {
7794 "exampleMetadata": "infused"
7795 },
7796 "example": "declare const dashboard: cloudwatch.Dashboard;\n\n// Import or create a lambda function\nconst fn = lambda.Function.fromFunctionArn(\n dashboard,\n 'Function',\n 'arn:aws:lambda:us-east-1:123456789012:function:MyFn',\n);\n\ndashboard.addWidgets(new cloudwatch.CustomWidget({\n functionArn: fn.functionArn,\n title: 'My lambda baked widget',\n}));",
7797 "stability": "stable",
7798 "summary": "A CustomWidget shows the result of a AWS lambda function."
7799 },
7800 "fqn": "@aws-cdk/aws-cloudwatch.CustomWidget",
7801 "initializer": {
7802 "docs": {
7803 "stability": "stable"
7804 },
7805 "locationInModule": {
7806 "filename": "lib/graph.ts",
7807 "line": 436
7808 },
7809 "parameters": [
7810 {
7811 "name": "props",
7812 "type": {
7813 "fqn": "@aws-cdk/aws-cloudwatch.CustomWidgetProps"
7814 }
7815 }
7816 ]
7817 },
7818 "kind": "class",
7819 "locationInModule": {
7820 "filename": "lib/graph.ts",
7821 "line": 432
7822 },
7823 "methods": [
7824 {
7825 "docs": {
7826 "stability": "stable",
7827 "summary": "Return the widget JSON for use in the dashboard."
7828 },
7829 "locationInModule": {
7830 "filename": "lib/graph.ts",
7831 "line": 441
7832 },
7833 "name": "toJson",
7834 "overrides": "@aws-cdk/aws-cloudwatch.ConcreteWidget",
7835 "returns": {
7836 "type": {
7837 "collection": {
7838 "elementtype": {
7839 "primitive": "any"
7840 },
7841 "kind": "array"
7842 }
7843 }
7844 }
7845 }
7846 ],
7847 "name": "CustomWidget",
7848 "symbolId": "lib/graph:CustomWidget"
7849 },
7850 "@aws-cdk/aws-cloudwatch.CustomWidgetProps": {
7851 "assembly": "@aws-cdk/aws-cloudwatch",
7852 "datatype": true,
7853 "docs": {
7854 "custom": {
7855 "exampleMetadata": "infused"
7856 },
7857 "example": "declare const dashboard: cloudwatch.Dashboard;\n\n// Import or create a lambda function\nconst fn = lambda.Function.fromFunctionArn(\n dashboard,\n 'Function',\n 'arn:aws:lambda:us-east-1:123456789012:function:MyFn',\n);\n\ndashboard.addWidgets(new cloudwatch.CustomWidget({\n functionArn: fn.functionArn,\n title: 'My lambda baked widget',\n}));",
7858 "stability": "stable",
7859 "summary": "The properties for a CustomWidget."
7860 },
7861 "fqn": "@aws-cdk/aws-cloudwatch.CustomWidgetProps",
7862 "kind": "interface",
7863 "locationInModule": {
7864 "filename": "lib/graph.ts",
7865 "line": 374
7866 },
7867 "name": "CustomWidgetProps",
7868 "properties": [
7869 {
7870 "abstract": true,
7871 "docs": {
7872 "stability": "stable",
7873 "summary": "The Arn of the AWS Lambda function that returns HTML or JSON that will be displayed in the widget."
7874 },
7875 "immutable": true,
7876 "locationInModule": {
7877 "filename": "lib/graph.ts",
7878 "line": 378
7879 },
7880 "name": "functionArn",
7881 "type": {
7882 "primitive": "string"
7883 }
7884 },
7885 {
7886 "abstract": true,
7887 "docs": {
7888 "stability": "stable",
7889 "summary": "The title of the widget."
7890 },
7891 "immutable": true,
7892 "locationInModule": {
7893 "filename": "lib/graph.ts",
7894 "line": 398
7895 },
7896 "name": "title",
7897 "type": {
7898 "primitive": "string"
7899 }
7900 },
7901 {
7902 "abstract": true,
7903 "docs": {
7904 "default": "- 6 for Alarm and Graph widgets.\n3 for single value widgets where most recent value of a metric is displayed.",
7905 "stability": "stable",
7906 "summary": "Height of the widget."
7907 },
7908 "immutable": true,
7909 "locationInModule": {
7910 "filename": "lib/graph.ts",
7911 "line": 393
7912 },
7913 "name": "height",
7914 "optional": true,
7915 "type": {
7916 "primitive": "number"
7917 }
7918 },
7919 {
7920 "abstract": true,
7921 "docs": {
7922 "default": "- no parameters are passed to the lambda function",
7923 "stability": "stable",
7924 "summary": "Parameters passed to the lambda function."
7925 },
7926 "immutable": true,
7927 "locationInModule": {
7928 "filename": "lib/graph.ts",
7929 "line": 426
7930 },
7931 "name": "params",
7932 "optional": true,
7933 "type": {
7934 "primitive": "any"
7935 }
7936 },
7937 {
7938 "abstract": true,
7939 "docs": {
7940 "default": "true",
7941 "stability": "stable",
7942 "summary": "Update the widget on refresh."
7943 },
7944 "immutable": true,
7945 "locationInModule": {
7946 "filename": "lib/graph.ts",
7947 "line": 405
7948 },
7949 "name": "updateOnRefresh",
7950 "optional": true,
7951 "type": {
7952 "primitive": "boolean"
7953 }
7954 },
7955 {
7956 "abstract": true,
7957 "docs": {
7958 "default": "true",
7959 "stability": "stable",
7960 "summary": "Update the widget on resize."
7961 },
7962 "immutable": true,
7963 "locationInModule": {
7964 "filename": "lib/graph.ts",
7965 "line": 412
7966 },
7967 "name": "updateOnResize",
7968 "optional": true,
7969 "type": {
7970 "primitive": "boolean"
7971 }
7972 },
7973 {
7974 "abstract": true,
7975 "docs": {
7976 "default": "true",
7977 "stability": "stable",
7978 "summary": "Update the widget on time range change."
7979 },
7980 "immutable": true,
7981 "locationInModule": {
7982 "filename": "lib/graph.ts",
7983 "line": 419
7984 },
7985 "name": "updateOnTimeRangeChange",
7986 "optional": true,
7987 "type": {
7988 "primitive": "boolean"
7989 }
7990 },
7991 {
7992 "abstract": true,
7993 "docs": {
7994 "default": "6",
7995 "stability": "stable",
7996 "summary": "Width of the widget, in a grid of 24 units wide."
7997 },
7998 "immutable": true,
7999 "locationInModule": {
8000 "filename": "lib/graph.ts",
8001 "line": 385
8002 },
8003 "name": "width",
8004 "optional": true,
8005 "type": {
8006 "primitive": "number"
8007 }
8008 }
8009 ],
8010 "symbolId": "lib/graph:CustomWidgetProps"
8011 },
8012 "@aws-cdk/aws-cloudwatch.Dashboard": {
8013 "assembly": "@aws-cdk/aws-cloudwatch",
8014 "base": "@aws-cdk/core.Resource",
8015 "docs": {
8016 "stability": "stable",
8017 "summary": "A CloudWatch dashboard.",
8018 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\n\ndeclare const widget: cloudwatch.IWidget;\nconst dashboard = new cloudwatch.Dashboard(this, 'MyDashboard', /* all optional props */ {\n dashboardName: 'dashboardName',\n end: 'end',\n periodOverride: cloudwatch.PeriodOverride.AUTO,\n start: 'start',\n widgets: [[widget]],\n});",
8019 "custom": {
8020 "exampleMetadata": "fixture=_generated"
8021 }
8022 },
8023 "fqn": "@aws-cdk/aws-cloudwatch.Dashboard",
8024 "initializer": {
8025 "docs": {
8026 "stability": "stable"
8027 },
8028 "locationInModule": {
8029 "filename": "lib/dashboard.ts",
8030 "line": 95
8031 },
8032 "parameters": [
8033 {
8034 "name": "scope",
8035 "type": {
8036 "fqn": "constructs.Construct"
8037 }
8038 },
8039 {
8040 "name": "id",
8041 "type": {
8042 "primitive": "string"
8043 }
8044 },
8045 {
8046 "name": "props",
8047 "optional": true,
8048 "type": {
8049 "fqn": "@aws-cdk/aws-cloudwatch.DashboardProps"
8050 }
8051 }
8052 ]
8053 },
8054 "kind": "class",
8055 "locationInModule": {
8056 "filename": "lib/dashboard.ts",
8057 "line": 77
8058 },
8059 "methods": [
8060 {
8061 "docs": {
8062 "remarks": "Widgets given in multiple calls to add() will be laid out stacked on\ntop of each other.\n\nMultiple widgets added in the same call to add() will be laid out next\nto each other.",
8063 "stability": "stable",
8064 "summary": "Add a widget to the dashboard."
8065 },
8066 "locationInModule": {
8067 "filename": "lib/dashboard.ts",
8068 "line": 148
8069 },
8070 "name": "addWidgets",
8071 "parameters": [
8072 {
8073 "name": "widgets",
8074 "type": {
8075 "fqn": "@aws-cdk/aws-cloudwatch.IWidget"
8076 },
8077 "variadic": true
8078 }
8079 ],
8080 "variadic": true
8081 }
8082 ],
8083 "name": "Dashboard",
8084 "properties": [
8085 {
8086 "docs": {
8087 "custom": {
8088 "attribute": "true"
8089 },
8090 "stability": "stable",
8091 "summary": "ARN of this dashboard."
8092 },
8093 "immutable": true,
8094 "locationInModule": {
8095 "filename": "lib/dashboard.ts",
8096 "line": 91
8097 },
8098 "name": "dashboardArn",
8099 "type": {
8100 "primitive": "string"
8101 }
8102 },
8103 {
8104 "docs": {
8105 "custom": {
8106 "attribute": "true"
8107 },
8108 "stability": "stable",
8109 "summary": "The name of this dashboard."
8110 },
8111 "immutable": true,
8112 "locationInModule": {
8113 "filename": "lib/dashboard.ts",
8114 "line": 84
8115 },
8116 "name": "dashboardName",
8117 "type": {
8118 "primitive": "string"
8119 }
8120 }
8121 ],
8122 "symbolId": "lib/dashboard:Dashboard"
8123 },
8124 "@aws-cdk/aws-cloudwatch.DashboardProps": {
8125 "assembly": "@aws-cdk/aws-cloudwatch",
8126 "datatype": true,
8127 "docs": {
8128 "stability": "stable",
8129 "summary": "Properties for defining a CloudWatch Dashboard.",
8130 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\n\ndeclare const widget: cloudwatch.IWidget;\nconst dashboardProps: cloudwatch.DashboardProps = {\n dashboardName: 'dashboardName',\n end: 'end',\n periodOverride: cloudwatch.PeriodOverride.AUTO,\n start: 'start',\n widgets: [[widget]],\n};",
8131 "custom": {
8132 "exampleMetadata": "fixture=_generated"
8133 }
8134 },
8135 "fqn": "@aws-cdk/aws-cloudwatch.DashboardProps",
8136 "kind": "interface",
8137 "locationInModule": {
8138 "filename": "lib/dashboard.ts",
8139 "line": 24
8140 },
8141 "name": "DashboardProps",
8142 "properties": [
8143 {
8144 "abstract": true,
8145 "docs": {
8146 "default": "- automatically generated name",
8147 "remarks": "If set, must only contain alphanumerics, dash (-) and underscore (_)",
8148 "stability": "stable",
8149 "summary": "Name of the dashboard."
8150 },
8151 "immutable": true,
8152 "locationInModule": {
8153 "filename": "lib/dashboard.ts",
8154 "line": 32
8155 },
8156 "name": "dashboardName",
8157 "optional": true,
8158 "type": {
8159 "primitive": "string"
8160 }
8161 },
8162 {
8163 "abstract": true,
8164 "docs": {
8165 "default": "When the dashboard loads, the end date will be the current time.",
8166 "remarks": "If you specify a value for end, you must also specify a value for start.\nSpecify an absolute time in the ISO 8601 format. For example, 2018-12-17T06:00:00.000Z.",
8167 "stability": "stable",
8168 "summary": "The end of the time range to use for each widget on the dashboard when the dashboard loads."
8169 },
8170 "immutable": true,
8171 "locationInModule": {
8172 "filename": "lib/dashboard.ts",
8173 "line": 53
8174 },
8175 "name": "end",
8176 "optional": true,
8177 "type": {
8178 "primitive": "string"
8179 }
8180 },
8181 {
8182 "abstract": true,
8183 "docs": {
8184 "default": "Auto",
8185 "remarks": "Specifying `Auto` causes the period of all graphs on the dashboard to automatically adapt to the time range of the dashboard.\nSpecifying `Inherit` ensures that the period set for each graph is always obeyed.",
8186 "stability": "stable",
8187 "summary": "Use this field to specify the period for the graphs when the dashboard loads."
8188 },
8189 "immutable": true,
8190 "locationInModule": {
8191 "filename": "lib/dashboard.ts",
8192 "line": 62
8193 },
8194 "name": "periodOverride",
8195 "optional": true,
8196 "type": {
8197 "fqn": "@aws-cdk/aws-cloudwatch.PeriodOverride"
8198 }
8199 },
8200 {
8201 "abstract": true,
8202 "docs": {
8203 "default": "When the dashboard loads, the start time will be the default time range.",
8204 "remarks": "You can specify start without specifying end to specify a relative time range that ends with the current time.\nIn this case, the value of start must begin with -P, and you can use M, H, D, W and M as abbreviations for\nminutes, hours, days, weeks and months. For example, -PT8H shows the last 8 hours and -P3M shows the last three months.\nYou can also use start along with an end field, to specify an absolute time range.\nWhen specifying an absolute time range, use the ISO 8601 format. For example, 2018-12-17T06:00:00.000Z.",
8205 "stability": "stable",
8206 "summary": "The start of the time range to use for each widget on the dashboard."
8207 },
8208 "immutable": true,
8209 "locationInModule": {
8210 "filename": "lib/dashboard.ts",
8211 "line": 44
8212 },
8213 "name": "start",
8214 "optional": true,
8215 "type": {
8216 "primitive": "string"
8217 }
8218 },
8219 {
8220 "abstract": true,
8221 "docs": {
8222 "default": "- No widgets",
8223 "remarks": "One array represents a row of widgets.",
8224 "stability": "stable",
8225 "summary": "Initial set of widgets on the dashboard."
8226 },
8227 "immutable": true,
8228 "locationInModule": {
8229 "filename": "lib/dashboard.ts",
8230 "line": 71
8231 },
8232 "name": "widgets",
8233 "optional": true,
8234 "type": {
8235 "collection": {
8236 "elementtype": {
8237 "collection": {
8238 "elementtype": {
8239 "fqn": "@aws-cdk/aws-cloudwatch.IWidget"
8240 },
8241 "kind": "array"
8242 }
8243 },
8244 "kind": "array"
8245 }
8246 }
8247 }
8248 ],
8249 "symbolId": "lib/dashboard:DashboardProps"
8250 },
8251 "@aws-cdk/aws-cloudwatch.Dimension": {
8252 "assembly": "@aws-cdk/aws-cloudwatch",
8253 "datatype": true,
8254 "docs": {
8255 "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html",
8256 "stability": "stable",
8257 "summary": "Metric dimension.",
8258 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\n\ndeclare const value: any;\nconst dimension: cloudwatch.Dimension = {\n name: 'name',\n value: value,\n};",
8259 "custom": {
8260 "exampleMetadata": "fixture=_generated"
8261 }
8262 },
8263 "fqn": "@aws-cdk/aws-cloudwatch.Dimension",
8264 "kind": "interface",
8265 "locationInModule": {
8266 "filename": "lib/metric-types.ts",
8267 "line": 42
8268 },
8269 "name": "Dimension",
8270 "properties": [
8271 {
8272 "abstract": true,
8273 "docs": {
8274 "stability": "stable",
8275 "summary": "Name of the dimension."
8276 },
8277 "immutable": true,
8278 "locationInModule": {
8279 "filename": "lib/metric-types.ts",
8280 "line": 46
8281 },
8282 "name": "name",
8283 "type": {
8284 "primitive": "string"
8285 }
8286 },
8287 {
8288 "abstract": true,
8289 "docs": {
8290 "stability": "stable",
8291 "summary": "Value of the dimension."
8292 },
8293 "immutable": true,
8294 "locationInModule": {
8295 "filename": "lib/metric-types.ts",
8296 "line": 51
8297 },
8298 "name": "value",
8299 "type": {
8300 "primitive": "any"
8301 }
8302 }
8303 ],
8304 "symbolId": "lib/metric-types:Dimension"
8305 },
8306 "@aws-cdk/aws-cloudwatch.GraphWidget": {
8307 "assembly": "@aws-cdk/aws-cloudwatch",
8308 "base": "@aws-cdk/aws-cloudwatch.ConcreteWidget",
8309 "docs": {
8310 "custom": {
8311 "exampleMetadata": "infused"
8312 },
8313 "example": "declare const dashboard: cloudwatch.Dashboard;\n\ndashboard.addWidgets(new cloudwatch.GraphWidget({\n // ...\n\n legendPosition: cloudwatch.LegendPosition.RIGHT,\n}));",
8314 "stability": "stable",
8315 "summary": "A dashboard widget that displays metrics."
8316 },
8317 "fqn": "@aws-cdk/aws-cloudwatch.GraphWidget",
8318 "initializer": {
8319 "docs": {
8320 "stability": "stable"
8321 },
8322 "locationInModule": {
8323 "filename": "lib/graph.ts",
8324 "line": 254
8325 },
8326 "parameters": [
8327 {
8328 "name": "props",
8329 "type": {
8330 "fqn": "@aws-cdk/aws-cloudwatch.GraphWidgetProps"
8331 }
8332 }
8333 ]
8334 },
8335 "kind": "class",
8336 "locationInModule": {
8337 "filename": "lib/graph.ts",
8338 "line": 247
8339 },
8340 "methods": [
8341 {
8342 "docs": {
8343 "stability": "stable",
8344 "summary": "Add another metric to the left Y axis of the GraphWidget."
8345 },
8346 "locationInModule": {
8347 "filename": "lib/graph.ts",
8348 "line": 267
8349 },
8350 "name": "addLeftMetric",
8351 "parameters": [
8352 {
8353 "docs": {
8354 "summary": "the metric to add."
8355 },
8356 "name": "metric",
8357 "type": {
8358 "fqn": "@aws-cdk/aws-cloudwatch.IMetric"
8359 }
8360 }
8361 ]
8362 },
8363 {
8364 "docs": {
8365 "stability": "stable",
8366 "summary": "Add another metric to the right Y axis of the GraphWidget."
8367 },
8368 "locationInModule": {
8369 "filename": "lib/graph.ts",
8370 "line": 277
8371 },
8372 "name": "addRightMetric",
8373 "parameters": [
8374 {
8375 "docs": {
8376 "summary": "the metric to add."
8377 },
8378 "name": "metric",
8379 "type": {
8380 "fqn": "@aws-cdk/aws-cloudwatch.IMetric"
8381 }
8382 }
8383 ]
8384 },
8385 {
8386 "docs": {
8387 "stability": "stable",
8388 "summary": "Return the widget JSON for use in the dashboard."
8389 },
8390 "locationInModule": {
8391 "filename": "lib/graph.ts",
8392 "line": 282
8393 },
8394 "name": "toJson",
8395 "overrides": "@aws-cdk/aws-cloudwatch.ConcreteWidget",
8396 "returns": {
8397 "type": {
8398 "collection": {
8399 "elementtype": {
8400 "primitive": "any"
8401 },
8402 "kind": "array"
8403 }
8404 }
8405 }
8406 }
8407 ],
8408 "name": "GraphWidget",
8409 "symbolId": "lib/graph:GraphWidget"
8410 },
8411 "@aws-cdk/aws-cloudwatch.GraphWidgetProps": {
8412 "assembly": "@aws-cdk/aws-cloudwatch",
8413 "datatype": true,
8414 "docs": {
8415 "custom": {
8416 "exampleMetadata": "infused"
8417 },
8418 "example": "declare const dashboard: cloudwatch.Dashboard;\n\ndashboard.addWidgets(new cloudwatch.GraphWidget({\n // ...\n\n legendPosition: cloudwatch.LegendPosition.RIGHT,\n}));",
8419 "stability": "stable",
8420 "summary": "Properties for a GraphWidget."
8421 },
8422 "fqn": "@aws-cdk/aws-cloudwatch.GraphWidgetProps",
8423 "interfaces": [
8424 "@aws-cdk/aws-cloudwatch.MetricWidgetProps"
8425 ],
8426 "kind": "interface",
8427 "locationInModule": {
8428 "filename": "lib/graph.ts",
8429 "line": 145
8430 },
8431 "name": "GraphWidgetProps",
8432 "properties": [
8433 {
8434 "abstract": true,
8435 "docs": {
8436 "default": "- No metrics",
8437 "stability": "stable",
8438 "summary": "Metrics to display on left Y axis."
8439 },
8440 "immutable": true,
8441 "locationInModule": {
8442 "filename": "lib/graph.ts",
8443 "line": 151
8444 },
8445 "name": "left",
8446 "optional": true,
8447 "type": {
8448 "collection": {
8449 "elementtype": {
8450 "fqn": "@aws-cdk/aws-cloudwatch.IMetric"
8451 },
8452 "kind": "array"
8453 }
8454 }
8455 },
8456 {
8457 "abstract": true,
8458 "docs": {
8459 "default": "- No annotations",
8460 "stability": "stable",
8461 "summary": "Annotations for the left Y axis."
8462 },
8463 "immutable": true,
8464 "locationInModule": {
8465 "filename": "lib/graph.ts",
8466 "line": 165
8467 },
8468 "name": "leftAnnotations",
8469 "optional": true,
8470 "type": {
8471 "collection": {
8472 "elementtype": {
8473 "fqn": "@aws-cdk/aws-cloudwatch.HorizontalAnnotation"
8474 },
8475 "kind": "array"
8476 }
8477 }
8478 },
8479 {
8480 "abstract": true,
8481 "docs": {
8482 "default": "- None",
8483 "stability": "stable",
8484 "summary": "Left Y axis."
8485 },
8486 "immutable": true,
8487 "locationInModule": {
8488 "filename": "lib/graph.ts",
8489 "line": 186
8490 },
8491 "name": "leftYAxis",
8492 "optional": true,
8493 "type": {
8494 "fqn": "@aws-cdk/aws-cloudwatch.YAxisProps"
8495 }
8496 },
8497 {
8498 "abstract": true,
8499 "docs": {
8500 "default": "- bottom",
8501 "stability": "stable",
8502 "summary": "Position of the legend."
8503 },
8504 "immutable": true,
8505 "locationInModule": {
8506 "filename": "lib/graph.ts",
8507 "line": 200
8508 },
8509 "name": "legendPosition",
8510 "optional": true,
8511 "type": {
8512 "fqn": "@aws-cdk/aws-cloudwatch.LegendPosition"
8513 }
8514 },
8515 {
8516 "abstract": true,
8517 "docs": {
8518 "default": "false",
8519 "stability": "stable",
8520 "summary": "Whether the graph should show live data."
8521 },
8522 "immutable": true,
8523 "locationInModule": {
8524 "filename": "lib/graph.ts",
8525 "line": 207
8526 },
8527 "name": "liveData",
8528 "optional": true,
8529 "type": {
8530 "primitive": "boolean"
8531 }
8532 },
8533 {
8534 "abstract": true,
8535 "docs": {
8536 "default": "cdk.Duration.seconds(300)",
8537 "remarks": "The period is the length of time represented by one data point on the graph.\nThis default can be overridden within each metric definition.",
8538 "stability": "stable",
8539 "summary": "The default period for all metrics in this widget."
8540 },
8541 "immutable": true,
8542 "locationInModule": {
8543 "filename": "lib/graph.ts",
8544 "line": 233
8545 },
8546 "name": "period",
8547 "optional": true,
8548 "type": {
8549 "fqn": "@aws-cdk/core.Duration"
8550 }
8551 },
8552 {
8553 "abstract": true,
8554 "docs": {
8555 "default": "- No metrics",
8556 "stability": "stable",
8557 "summary": "Metrics to display on right Y axis."
8558 },
8559 "immutable": true,
8560 "locationInModule": {
8561 "filename": "lib/graph.ts",
8562 "line": 158
8563 },
8564 "name": "right",
8565 "optional": true,
8566 "type": {
8567 "collection": {
8568 "elementtype": {
8569 "fqn": "@aws-cdk/aws-cloudwatch.IMetric"
8570 },
8571 "kind": "array"
8572 }
8573 }
8574 },
8575 {
8576 "abstract": true,
8577 "docs": {
8578 "default": "- No annotations",
8579 "stability": "stable",
8580 "summary": "Annotations for the right Y axis."
8581 },
8582 "immutable": true,
8583 "locationInModule": {
8584 "filename": "lib/graph.ts",
8585 "line": 172
8586 },
8587 "name": "rightAnnotations",
8588 "optional": true,
8589 "type": {
8590 "collection": {
8591 "elementtype": {
8592 "fqn": "@aws-cdk/aws-cloudwatch.HorizontalAnnotation"
8593 },
8594 "kind": "array"
8595 }
8596 }
8597 },
8598 {
8599 "abstract": true,
8600 "docs": {
8601 "default": "- None",
8602 "stability": "stable",
8603 "summary": "Right Y axis."
8604 },
8605 "immutable": true,
8606 "locationInModule": {
8607 "filename": "lib/graph.ts",
8608 "line": 193
8609 },
8610 "name": "rightYAxis",
8611 "optional": true,
8612 "type": {
8613 "fqn": "@aws-cdk/aws-cloudwatch.YAxisProps"
8614 }
8615 },
8616 {
8617 "abstract": true,
8618 "docs": {
8619 "default": "false",
8620 "remarks": "If false, values will be from the most recent period of your chosen time range;\nif true, shows the value from the entire time range.",
8621 "stability": "stable",
8622 "summary": "Whether to show the value from the entire time range. Only applicable for Bar and Pie charts."
8623 },
8624 "immutable": true,
8625 "locationInModule": {
8626 "filename": "lib/graph.ts",
8627 "line": 224
8628 },
8629 "name": "setPeriodToTimeRange",
8630 "optional": true,
8631 "type": {
8632 "primitive": "boolean"
8633 }
8634 },
8635 {
8636 "abstract": true,
8637 "docs": {
8638 "default": "false",
8639 "stability": "stable",
8640 "summary": "Whether the graph should be shown as stacked lines."
8641 },
8642 "immutable": true,
8643 "locationInModule": {
8644 "filename": "lib/graph.ts",
8645 "line": 179
8646 },
8647 "name": "stacked",
8648 "optional": true,
8649 "type": {
8650 "primitive": "boolean"
8651 }
8652 },
8653 {
8654 "abstract": true,
8655 "docs": {
8656 "default": "- The statistic for each metric is used",
8657 "remarks": "This default can be overridden within the definition of each individual metric",
8658 "stability": "stable",
8659 "summary": "The default statistic to be displayed for each metric."
8660 },
8661 "immutable": true,
8662 "locationInModule": {
8663 "filename": "lib/graph.ts",
8664 "line": 241
8665 },
8666 "name": "statistic",
8667 "optional": true,
8668 "type": {
8669 "primitive": "string"
8670 }
8671 },
8672 {
8673 "abstract": true,
8674 "docs": {
8675 "default": "TimeSeries",
8676 "stability": "stable",
8677 "summary": "Display this metric."
8678 },
8679 "immutable": true,
8680 "locationInModule": {
8681 "filename": "lib/graph.ts",
8682 "line": 214
8683 },
8684 "name": "view",
8685 "optional": true,
8686 "type": {
8687 "fqn": "@aws-cdk/aws-cloudwatch.GraphWidgetView"
8688 }
8689 }
8690 ],
8691 "symbolId": "lib/graph:GraphWidgetProps"
8692 },
8693 "@aws-cdk/aws-cloudwatch.GraphWidgetView": {
8694 "assembly": "@aws-cdk/aws-cloudwatch",
8695 "docs": {
8696 "custom": {
8697 "exampleMetadata": "infused"
8698 },
8699 "example": "declare const dashboard: cloudwatch.Dashboard;\n\ndashboard.addWidgets(new cloudwatch.GraphWidget({\n // ...\n\n view: cloudwatch.GraphWidgetView.BAR,\n}));",
8700 "stability": "stable",
8701 "summary": "Types of view."
8702 },
8703 "fqn": "@aws-cdk/aws-cloudwatch.GraphWidgetView",
8704 "kind": "enum",
8705 "locationInModule": {
8706 "filename": "lib/graph.ts",
8707 "line": 127
8708 },
8709 "members": [
8710 {
8711 "docs": {
8712 "stability": "stable",
8713 "summary": "Display as a line graph."
8714 },
8715 "name": "TIME_SERIES"
8716 },
8717 {
8718 "docs": {
8719 "stability": "stable",
8720 "summary": "Display as a bar graph."
8721 },
8722 "name": "BAR"
8723 },
8724 {
8725 "docs": {
8726 "stability": "stable",
8727 "summary": "Display as a pie graph."
8728 },
8729 "name": "PIE"
8730 }
8731 ],
8732 "name": "GraphWidgetView",
8733 "symbolId": "lib/graph:GraphWidgetView"
8734 },
8735 "@aws-cdk/aws-cloudwatch.HorizontalAnnotation": {
8736 "assembly": "@aws-cdk/aws-cloudwatch",
8737 "datatype": true,
8738 "docs": {
8739 "stability": "stable",
8740 "summary": "Horizontal annotation to be added to a graph.",
8741 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst horizontalAnnotation: cloudwatch.HorizontalAnnotation = {\n value: 123,\n\n // the properties below are optional\n color: 'color',\n fill: cloudwatch.Shading.NONE,\n label: 'label',\n visible: false,\n};",
8742 "custom": {
8743 "exampleMetadata": "fixture=_generated"
8744 }
8745 },
8746 "fqn": "@aws-cdk/aws-cloudwatch.HorizontalAnnotation",
8747 "kind": "interface",
8748 "locationInModule": {
8749 "filename": "lib/graph.ts",
8750 "line": 465
8751 },
8752 "name": "HorizontalAnnotation",
8753 "properties": [
8754 {
8755 "abstract": true,
8756 "docs": {
8757 "stability": "stable",
8758 "summary": "The value of the annotation."
8759 },
8760 "immutable": true,
8761 "locationInModule": {
8762 "filename": "lib/graph.ts",
8763 "line": 469
8764 },
8765 "name": "value",
8766 "type": {
8767 "primitive": "number"
8768 }
8769 },
8770 {
8771 "abstract": true,
8772 "docs": {
8773 "default": "- Automatic color",
8774 "stability": "stable",
8775 "summary": "The hex color code, prefixed with '#' (e.g. '#00ff00'), to be used for the annotation. The `Color` class has a set of standard colors that can be used here."
8776 },
8777 "immutable": true,
8778 "locationInModule": {
8779 "filename": "lib/graph.ts",
8780 "line": 484
8781 },
8782 "name": "color",
8783 "optional": true,
8784 "type": {
8785 "primitive": "string"
8786 }
8787 },
8788 {
8789 "abstract": true,
8790 "docs": {
8791 "default": "No shading",
8792 "stability": "stable",
8793 "summary": "Add shading above or below the annotation."
8794 },
8795 "immutable": true,
8796 "locationInModule": {
8797 "filename": "lib/graph.ts",
8798 "line": 491
8799 },
8800 "name": "fill",
8801 "optional": true,
8802 "type": {
8803 "fqn": "@aws-cdk/aws-cloudwatch.Shading"
8804 }
8805 },
8806 {
8807 "abstract": true,
8808 "docs": {
8809 "default": "- No label",
8810 "stability": "stable",
8811 "summary": "Label for the annotation."
8812 },
8813 "immutable": true,
8814 "locationInModule": {
8815 "filename": "lib/graph.ts",
8816 "line": 476
8817 },
8818 "name": "label",
8819 "optional": true,
8820 "type": {
8821 "primitive": "string"
8822 }
8823 },
8824 {
8825 "abstract": true,
8826 "docs": {
8827 "default": "true",
8828 "stability": "stable",
8829 "summary": "Whether the annotation is visible."
8830 },
8831 "immutable": true,
8832 "locationInModule": {
8833 "filename": "lib/graph.ts",
8834 "line": 498
8835 },
8836 "name": "visible",
8837 "optional": true,
8838 "type": {
8839 "primitive": "boolean"
8840 }
8841 }
8842 ],
8843 "symbolId": "lib/graph:HorizontalAnnotation"
8844 },
8845 "@aws-cdk/aws-cloudwatch.IAlarm": {
8846 "assembly": "@aws-cdk/aws-cloudwatch",
8847 "docs": {
8848 "stability": "stable",
8849 "summary": "Represents a CloudWatch Alarm."
8850 },
8851 "fqn": "@aws-cdk/aws-cloudwatch.IAlarm",
8852 "interfaces": [
8853 "@aws-cdk/aws-cloudwatch.IAlarmRule",
8854 "@aws-cdk/core.IResource"
8855 ],
8856 "kind": "interface",
8857 "locationInModule": {
8858 "filename": "lib/alarm-base.ts",
8859 "line": 19
8860 },
8861 "name": "IAlarm",
8862 "properties": [
8863 {
8864 "abstract": true,
8865 "docs": {
8866 "custom": {
8867 "attribute": "true"
8868 },
8869 "stability": "stable",
8870 "summary": "Alarm ARN (i.e. arn:aws:cloudwatch:<region>:<account-id>:alarm:Foo)."
8871 },
8872 "immutable": true,
8873 "locationInModule": {
8874 "filename": "lib/alarm-base.ts",
8875 "line": 25
8876 },
8877 "name": "alarmArn",
8878 "type": {
8879 "primitive": "string"
8880 }
8881 },
8882 {
8883 "abstract": true,
8884 "docs": {
8885 "custom": {
8886 "attribute": "true"
8887 },
8888 "stability": "stable",
8889 "summary": "Name of the alarm."
8890 },
8891 "immutable": true,
8892 "locationInModule": {
8893 "filename": "lib/alarm-base.ts",
8894 "line": 32
8895 },
8896 "name": "alarmName",
8897 "type": {
8898 "primitive": "string"
8899 }
8900 }
8901 ],
8902 "symbolId": "lib/alarm-base:IAlarm"
8903 },
8904 "@aws-cdk/aws-cloudwatch.IAlarmAction": {
8905 "assembly": "@aws-cdk/aws-cloudwatch",
8906 "docs": {
8907 "stability": "stable",
8908 "summary": "Interface for objects that can be the targets of CloudWatch alarm actions."
8909 },
8910 "fqn": "@aws-cdk/aws-cloudwatch.IAlarmAction",
8911 "kind": "interface",
8912 "locationInModule": {
8913 "filename": "lib/alarm-action.ts",
8914 "line": 11
8915 },
8916 "methods": [
8917 {
8918 "abstract": true,
8919 "docs": {
8920 "stability": "stable",
8921 "summary": "Return the properties required to send alarm actions to this CloudWatch alarm."
8922 },
8923 "locationInModule": {
8924 "filename": "lib/alarm-action.ts",
8925 "line": 18
8926 },
8927 "name": "bind",
8928 "parameters": [
8929 {
8930 "docs": {
8931 "summary": "root Construct that allows creating new Constructs."
8932 },
8933 "name": "scope",
8934 "type": {
8935 "fqn": "@aws-cdk/core.Construct"
8936 }
8937 },
8938 {
8939 "docs": {
8940 "summary": "CloudWatch alarm that the action will target."
8941 },
8942 "name": "alarm",
8943 "type": {
8944 "fqn": "@aws-cdk/aws-cloudwatch.IAlarm"
8945 }
8946 }
8947 ],
8948 "returns": {
8949 "type": {
8950 "fqn": "@aws-cdk/aws-cloudwatch.AlarmActionConfig"
8951 }
8952 }
8953 }
8954 ],
8955 "name": "IAlarmAction",
8956 "symbolId": "lib/alarm-action:IAlarmAction"
8957 },
8958 "@aws-cdk/aws-cloudwatch.IAlarmRule": {
8959 "assembly": "@aws-cdk/aws-cloudwatch",
8960 "docs": {
8961 "stability": "stable",
8962 "summary": "Interface for Alarm Rule."
8963 },
8964 "fqn": "@aws-cdk/aws-cloudwatch.IAlarmRule",
8965 "kind": "interface",
8966 "locationInModule": {
8967 "filename": "lib/alarm-base.ts",
8968 "line": 7
8969 },
8970 "methods": [
8971 {
8972 "abstract": true,
8973 "docs": {
8974 "stability": "stable",
8975 "summary": "serialized representation of Alarm Rule to be used when building the Composite Alarm resource."
8976 },
8977 "locationInModule": {
8978 "filename": "lib/alarm-base.ts",
8979 "line": 12
8980 },
8981 "name": "renderAlarmRule",
8982 "returns": {
8983 "type": {
8984 "primitive": "string"
8985 }
8986 }
8987 }
8988 ],
8989 "name": "IAlarmRule",
8990 "symbolId": "lib/alarm-base:IAlarmRule"
8991 },
8992 "@aws-cdk/aws-cloudwatch.IMetric": {
8993 "assembly": "@aws-cdk/aws-cloudwatch",
8994 "docs": {
8995 "stability": "stable",
8996 "summary": "Interface for metrics."
8997 },
8998 "fqn": "@aws-cdk/aws-cloudwatch.IMetric",
8999 "kind": "interface",
9000 "locationInModule": {
9001 "filename": "lib/metric-types.ts",
9002 "line": 6
9003 },
9004 "methods": [
9005 {
9006 "abstract": true,
9007 "docs": {
9008 "deprecated": "Use `toMetricConfig()` instead.",
9009 "stability": "deprecated",
9010 "summary": "Turn this metric object into an alarm configuration."
9011 },
9012 "locationInModule": {
9013 "filename": "lib/metric-types.ts",
9014 "line": 26
9015 },
9016 "name": "toAlarmConfig",
9017 "returns": {
9018 "type": {
9019 "fqn": "@aws-cdk/aws-cloudwatch.MetricAlarmConfig"
9020 }
9021 }
9022 },
9023 {
9024 "abstract": true,
9025 "docs": {
9026 "deprecated": "Use `toMetricConfig()` instead.",
9027 "stability": "deprecated",
9028 "summary": "Turn this metric object into a graph configuration."
9029 },
9030 "locationInModule": {
9031 "filename": "lib/metric-types.ts",
9032 "line": 33
9033 },
9034 "name": "toGraphConfig",
9035 "returns": {
9036 "type": {
9037 "fqn": "@aws-cdk/aws-cloudwatch.MetricGraphConfig"
9038 }
9039 }
9040 },
9041 {
9042 "abstract": true,
9043 "docs": {
9044 "stability": "stable",
9045 "summary": "Inspect the details of the metric object."
9046 },
9047 "locationInModule": {
9048 "filename": "lib/metric-types.ts",
9049 "line": 19
9050 },
9051 "name": "toMetricConfig",
9052 "returns": {
9053 "type": {
9054 "fqn": "@aws-cdk/aws-cloudwatch.MetricConfig"
9055 }
9056 }
9057 }
9058 ],
9059 "name": "IMetric",
9060 "properties": [
9061 {
9062 "abstract": true,
9063 "docs": {
9064 "default": "- None",
9065 "remarks": "Should be attached to the consuming construct.",
9066 "stability": "stable",
9067 "summary": "Any warnings related to this metric."
9068 },
9069 "immutable": true,
9070 "locationInModule": {
9071 "filename": "lib/metric-types.ts",
9072 "line": 14
9073 },
9074 "name": "warnings",
9075 "optional": true,
9076 "type": {
9077 "collection": {
9078 "elementtype": {
9079 "primitive": "string"
9080 },
9081 "kind": "array"
9082 }
9083 }
9084 }
9085 ],
9086 "symbolId": "lib/metric-types:IMetric"
9087 },
9088 "@aws-cdk/aws-cloudwatch.IWidget": {
9089 "assembly": "@aws-cdk/aws-cloudwatch",
9090 "docs": {
9091 "stability": "stable",
9092 "summary": "A single dashboard widget."
9093 },
9094 "fqn": "@aws-cdk/aws-cloudwatch.IWidget",
9095 "kind": "interface",
9096 "locationInModule": {
9097 "filename": "lib/widget.ts",
9098 "line": 11
9099 },
9100 "methods": [
9101 {
9102 "abstract": true,
9103 "docs": {
9104 "stability": "stable",
9105 "summary": "Place the widget at a given position."
9106 },
9107 "locationInModule": {
9108 "filename": "lib/widget.ts",
9109 "line": 30
9110 },
9111 "name": "position",
9112 "parameters": [
9113 {
9114 "name": "x",
9115 "type": {
9116 "primitive": "number"
9117 }
9118 },
9119 {
9120 "name": "y",
9121 "type": {
9122 "primitive": "number"
9123 }
9124 }
9125 ]
9126 },
9127 {
9128 "abstract": true,
9129 "docs": {
9130 "stability": "stable",
9131 "summary": "Return the widget JSON for use in the dashboard."
9132 },
9133 "locationInModule": {
9134 "filename": "lib/widget.ts",
9135 "line": 35
9136 },
9137 "name": "toJson",
9138 "returns": {
9139 "type": {
9140 "collection": {
9141 "elementtype": {
9142 "primitive": "any"
9143 },
9144 "kind": "array"
9145 }
9146 }
9147 }
9148 }
9149 ],
9150 "name": "IWidget",
9151 "properties": [
9152 {
9153 "abstract": true,
9154 "docs": {
9155 "stability": "stable",
9156 "summary": "The amount of vertical grid units the widget will take up."
9157 },
9158 "immutable": true,
9159 "locationInModule": {
9160 "filename": "lib/widget.ts",
9161 "line": 20
9162 },
9163 "name": "height",
9164 "type": {
9165 "primitive": "number"
9166 }
9167 },
9168 {
9169 "abstract": true,
9170 "docs": {
9171 "stability": "stable",
9172 "summary": "The amount of horizontal grid units the widget will take up."
9173 },
9174 "immutable": true,
9175 "locationInModule": {
9176 "filename": "lib/widget.ts",
9177 "line": 15
9178 },
9179 "name": "width",
9180 "type": {
9181 "primitive": "number"
9182 }
9183 },
9184 {
9185 "abstract": true,
9186 "docs": {
9187 "stability": "stable",
9188 "summary": "Any warnings that are produced as a result of putting together this widget."
9189 },
9190 "immutable": true,
9191 "locationInModule": {
9192 "filename": "lib/widget.ts",
9193 "line": 25
9194 },
9195 "name": "warnings",
9196 "optional": true,
9197 "type": {
9198 "collection": {
9199 "elementtype": {
9200 "primitive": "string"
9201 },
9202 "kind": "array"
9203 }
9204 }
9205 }
9206 ],
9207 "symbolId": "lib/widget:IWidget"
9208 },
9209 "@aws-cdk/aws-cloudwatch.LegendPosition": {
9210 "assembly": "@aws-cdk/aws-cloudwatch",
9211 "docs": {
9212 "custom": {
9213 "exampleMetadata": "infused"
9214 },
9215 "example": "declare const dashboard: cloudwatch.Dashboard;\n\ndashboard.addWidgets(new cloudwatch.GraphWidget({\n // ...\n\n legendPosition: cloudwatch.LegendPosition.RIGHT,\n}));",
9216 "stability": "stable",
9217 "summary": "The position of the legend on a GraphWidget."
9218 },
9219 "fqn": "@aws-cdk/aws-cloudwatch.LegendPosition",
9220 "kind": "enum",
9221 "locationInModule": {
9222 "filename": "lib/graph.ts",
9223 "line": 555
9224 },
9225 "members": [
9226 {
9227 "docs": {
9228 "stability": "stable",
9229 "summary": "Legend appears below the graph (default)."
9230 },
9231 "name": "BOTTOM"
9232 },
9233 {
9234 "docs": {
9235 "stability": "stable",
9236 "summary": "Add shading above the annotation."
9237 },
9238 "name": "RIGHT"
9239 },
9240 {
9241 "docs": {
9242 "stability": "stable",
9243 "summary": "Add shading below the annotation."
9244 },
9245 "name": "HIDDEN"
9246 }
9247 ],
9248 "name": "LegendPosition",
9249 "symbolId": "lib/graph:LegendPosition"
9250 },
9251 "@aws-cdk/aws-cloudwatch.LogQueryVisualizationType": {
9252 "assembly": "@aws-cdk/aws-cloudwatch",
9253 "docs": {
9254 "custom": {
9255 "exampleMetadata": "infused"
9256 },
9257 "example": "declare const dashboard: cloudwatch.Dashboard;\n\ndashboard.addWidgets(new cloudwatch.LogQueryWidget({\n logGroupNames: ['my-log-group'],\n view: cloudwatch.LogQueryVisualizationType.TABLE,\n // The lines will be automatically combined using '\\n|'.\n queryLines: [\n 'fields @message',\n 'filter @message like /Error/',\n ]\n}));",
9258 "stability": "stable",
9259 "summary": "Types of view."
9260 },
9261 "fqn": "@aws-cdk/aws-cloudwatch.LogQueryVisualizationType",
9262 "kind": "enum",
9263 "locationInModule": {
9264 "filename": "lib/log-query.ts",
9265 "line": 7
9266 },
9267 "members": [
9268 {
9269 "docs": {
9270 "stability": "stable",
9271 "summary": "Table view."
9272 },
9273 "name": "TABLE"
9274 },
9275 {
9276 "docs": {
9277 "stability": "stable",
9278 "summary": "Line view."
9279 },
9280 "name": "LINE"
9281 },
9282 {
9283 "docs": {
9284 "stability": "stable",
9285 "summary": "Stacked area view."
9286 },
9287 "name": "STACKEDAREA"
9288 },
9289 {
9290 "docs": {
9291 "stability": "stable",
9292 "summary": "Bar view."
9293 },
9294 "name": "BAR"
9295 },
9296 {
9297 "docs": {
9298 "stability": "stable",
9299 "summary": "Pie view."
9300 },
9301 "name": "PIE"
9302 }
9303 ],
9304 "name": "LogQueryVisualizationType",
9305 "symbolId": "lib/log-query:LogQueryVisualizationType"
9306 },
9307 "@aws-cdk/aws-cloudwatch.LogQueryWidget": {
9308 "assembly": "@aws-cdk/aws-cloudwatch",
9309 "base": "@aws-cdk/aws-cloudwatch.ConcreteWidget",
9310 "docs": {
9311 "custom": {
9312 "exampleMetadata": "infused"
9313 },
9314 "example": "declare const dashboard: cloudwatch.Dashboard;\n\ndashboard.addWidgets(new cloudwatch.LogQueryWidget({\n logGroupNames: ['my-log-group'],\n view: cloudwatch.LogQueryVisualizationType.TABLE,\n // The lines will be automatically combined using '\\n|'.\n queryLines: [\n 'fields @message',\n 'filter @message like /Error/',\n ]\n}));",
9315 "stability": "stable",
9316 "summary": "Display query results from Logs Insights."
9317 },
9318 "fqn": "@aws-cdk/aws-cloudwatch.LogQueryWidget",
9319 "initializer": {
9320 "docs": {
9321 "stability": "stable"
9322 },
9323 "locationInModule": {
9324 "filename": "lib/log-query.ts",
9325 "line": 100
9326 },
9327 "parameters": [
9328 {
9329 "name": "props",
9330 "type": {
9331 "fqn": "@aws-cdk/aws-cloudwatch.LogQueryWidgetProps"
9332 }
9333 }
9334 ]
9335 },
9336 "kind": "class",
9337 "locationInModule": {
9338 "filename": "lib/log-query.ts",
9339 "line": 97
9340 },
9341 "methods": [
9342 {
9343 "docs": {
9344 "stability": "stable",
9345 "summary": "Return the widget JSON for use in the dashboard."
9346 },
9347 "locationInModule": {
9348 "filename": "lib/log-query.ts",
9349 "line": 113
9350 },
9351 "name": "toJson",
9352 "overrides": "@aws-cdk/aws-cloudwatch.ConcreteWidget",
9353 "returns": {
9354 "type": {
9355 "collection": {
9356 "elementtype": {
9357 "primitive": "any"
9358 },
9359 "kind": "array"
9360 }
9361 }
9362 }
9363 }
9364 ],
9365 "name": "LogQueryWidget",
9366 "symbolId": "lib/log-query:LogQueryWidget"
9367 },
9368 "@aws-cdk/aws-cloudwatch.LogQueryWidgetProps": {
9369 "assembly": "@aws-cdk/aws-cloudwatch",
9370 "datatype": true,
9371 "docs": {
9372 "custom": {
9373 "exampleMetadata": "infused"
9374 },
9375 "example": "declare const dashboard: cloudwatch.Dashboard;\n\ndashboard.addWidgets(new cloudwatch.LogQueryWidget({\n logGroupNames: ['my-log-group'],\n view: cloudwatch.LogQueryVisualizationType.TABLE,\n // The lines will be automatically combined using '\\n|'.\n queryLines: [\n 'fields @message',\n 'filter @message like /Error/',\n ]\n}));",
9376 "stability": "stable",
9377 "summary": "Properties for a Query widget."
9378 },
9379 "fqn": "@aws-cdk/aws-cloudwatch.LogQueryWidgetProps",
9380 "kind": "interface",
9381 "locationInModule": {
9382 "filename": "lib/log-query.ts",
9383 "line": 33
9384 },
9385 "name": "LogQueryWidgetProps",
9386 "properties": [
9387 {
9388 "abstract": true,
9389 "docs": {
9390 "stability": "stable",
9391 "summary": "Names of log groups to query."
9392 },
9393 "immutable": true,
9394 "locationInModule": {
9395 "filename": "lib/log-query.ts",
9396 "line": 44
9397 },
9398 "name": "logGroupNames",
9399 "type": {
9400 "collection": {
9401 "elementtype": {
9402 "primitive": "string"
9403 },
9404 "kind": "array"
9405 }
9406 }
9407 },
9408 {
9409 "abstract": true,
9410 "docs": {
9411 "default": "6",
9412 "stability": "stable",
9413 "summary": "Height of the widget."
9414 },
9415 "immutable": true,
9416 "locationInModule": {
9417 "filename": "lib/log-query.ts",
9418 "line": 91
9419 },
9420 "name": "height",
9421 "optional": true,
9422 "type": {
9423 "primitive": "number"
9424 }
9425 },
9426 {
9427 "abstract": true,
9428 "docs": {
9429 "default": "- Exactly one of `queryString`, `queryLines` is required.",
9430 "remarks": "The query will be built by joining the lines together using `\\n|`.",
9431 "stability": "stable",
9432 "summary": "A sequence of lines to use to build the query."
9433 },
9434 "immutable": true,
9435 "locationInModule": {
9436 "filename": "lib/log-query.ts",
9437 "line": 63
9438 },
9439 "name": "queryLines",
9440 "optional": true,
9441 "type": {
9442 "collection": {
9443 "elementtype": {
9444 "primitive": "string"
9445 },
9446 "kind": "array"
9447 }
9448 }
9449 },
9450 {
9451 "abstract": true,
9452 "docs": {
9453 "default": "- Exactly one of `queryString`, `queryLines` is required.",
9454 "remarks": "Be sure to prepend every new line with a newline and pipe character\n(`\\n|`).",
9455 "stability": "stable",
9456 "summary": "Full query string for log insights."
9457 },
9458 "immutable": true,
9459 "locationInModule": {
9460 "filename": "lib/log-query.ts",
9461 "line": 54
9462 },
9463 "name": "queryString",
9464 "optional": true,
9465 "type": {
9466 "primitive": "string"
9467 }
9468 },
9469 {
9470 "abstract": true,
9471 "docs": {
9472 "default": "Current region",
9473 "stability": "stable",
9474 "summary": "The region the metrics of this widget should be taken from."
9475 },
9476 "immutable": true,
9477 "locationInModule": {
9478 "filename": "lib/log-query.ts",
9479 "line": 70
9480 },
9481 "name": "region",
9482 "optional": true,
9483 "type": {
9484 "primitive": "string"
9485 }
9486 },
9487 {
9488 "abstract": true,
9489 "docs": {
9490 "default": "No title",
9491 "stability": "stable",
9492 "summary": "Title for the widget."
9493 },
9494 "immutable": true,
9495 "locationInModule": {
9496 "filename": "lib/log-query.ts",
9497 "line": 39
9498 },
9499 "name": "title",
9500 "optional": true,
9501 "type": {
9502 "primitive": "string"
9503 }
9504 },
9505 {
9506 "abstract": true,
9507 "docs": {
9508 "default": "LogQueryVisualizationType.TABLE",
9509 "stability": "stable",
9510 "summary": "The type of view to use."
9511 },
9512 "immutable": true,
9513 "locationInModule": {
9514 "filename": "lib/log-query.ts",
9515 "line": 77
9516 },
9517 "name": "view",
9518 "optional": true,
9519 "type": {
9520 "fqn": "@aws-cdk/aws-cloudwatch.LogQueryVisualizationType"
9521 }
9522 },
9523 {
9524 "abstract": true,
9525 "docs": {
9526 "default": "6",
9527 "stability": "stable",
9528 "summary": "Width of the widget, in a grid of 24 units wide."
9529 },
9530 "immutable": true,
9531 "locationInModule": {
9532 "filename": "lib/log-query.ts",
9533 "line": 84
9534 },
9535 "name": "width",
9536 "optional": true,
9537 "type": {
9538 "primitive": "number"
9539 }
9540 }
9541 ],
9542 "symbolId": "lib/log-query:LogQueryWidgetProps"
9543 },
9544 "@aws-cdk/aws-cloudwatch.MathExpression": {
9545 "assembly": "@aws-cdk/aws-cloudwatch",
9546 "docs": {
9547 "custom": {
9548 "exampleMetadata": "infused"
9549 },
9550 "example": "declare const fn: lambda.Function;\n\nconst allProblems = new cloudwatch.MathExpression({\n expression: \"errors + throttles\",\n usingMetrics: {\n errors: fn.metricErrors(),\n faults: fn.metricThrottles(),\n }\n});",
9551 "remarks": "The math expression is a combination of an expression (x+y) and metrics to apply expression on.\nIt also contains metadata which is used only in graphs, such as color and label.\nIt makes sense to embed this in here, so that compound constructs can attach\nthat metadata to metrics they expose.\n\nMathExpression can also be used for search expressions. In this case,\nit also optionally accepts a searchRegion and searchAccount property for cross-environment\nsearch expressions.\n\nThis class does not represent a resource, so hence is not a construct. Instead,\nMathExpression is an abstraction that makes it easy to specify metrics for use in both\nalarms and graphs.",
9552 "stability": "stable",
9553 "summary": "A math expression built with metric(s) emitted by a service."
9554 },
9555 "fqn": "@aws-cdk/aws-cloudwatch.MathExpression",
9556 "initializer": {
9557 "docs": {
9558 "stability": "stable"
9559 },
9560 "locationInModule": {
9561 "filename": "lib/metric.ts",
9562 "line": 565
9563 },
9564 "parameters": [
9565 {
9566 "name": "props",
9567 "type": {
9568 "fqn": "@aws-cdk/aws-cloudwatch.MathExpressionProps"
9569 }
9570 }
9571 ]
9572 },
9573 "interfaces": [
9574 "@aws-cdk/aws-cloudwatch.IMetric"
9575 ],
9576 "kind": "class",
9577 "locationInModule": {
9578 "filename": "lib/metric.ts",
9579 "line": 523
9580 },
9581 "methods": [
9582 {
9583 "docs": {
9584 "remarks": "Combines both properties that may adjust the metric (aggregation) as well\nas alarm properties.",
9585 "stability": "stable",
9586 "summary": "Make a new Alarm for this metric."
9587 },
9588 "locationInModule": {
9589 "filename": "lib/metric.ts",
9590 "line": 667
9591 },
9592 "name": "createAlarm",
9593 "parameters": [
9594 {
9595 "name": "scope",
9596 "type": {
9597 "fqn": "@aws-cdk/core.Construct"
9598 }
9599 },
9600 {
9601 "name": "id",
9602 "type": {
9603 "primitive": "string"
9604 }
9605 },
9606 {
9607 "name": "props",
9608 "type": {
9609 "fqn": "@aws-cdk/aws-cloudwatch.CreateAlarmOptions"
9610 }
9611 }
9612 ],
9613 "returns": {
9614 "type": {
9615 "fqn": "@aws-cdk/aws-cloudwatch.Alarm"
9616 }
9617 }
9618 },
9619 {
9620 "docs": {
9621 "deprecated": "use toMetricConfig()",
9622 "stability": "deprecated",
9623 "summary": "Turn this metric object into an alarm configuration."
9624 },
9625 "locationInModule": {
9626 "filename": "lib/metric.ts",
9627 "line": 634
9628 },
9629 "name": "toAlarmConfig",
9630 "overrides": "@aws-cdk/aws-cloudwatch.IMetric",
9631 "returns": {
9632 "type": {
9633 "fqn": "@aws-cdk/aws-cloudwatch.MetricAlarmConfig"
9634 }
9635 }
9636 },
9637 {
9638 "docs": {
9639 "deprecated": "use toMetricConfig()",
9640 "stability": "deprecated",
9641 "summary": "Turn this metric object into a graph configuration."
9642 },
9643 "locationInModule": {
9644 "filename": "lib/metric.ts",
9645 "line": 641
9646 },
9647 "name": "toGraphConfig",
9648 "overrides": "@aws-cdk/aws-cloudwatch.IMetric",
9649 "returns": {
9650 "type": {
9651 "fqn": "@aws-cdk/aws-cloudwatch.MetricGraphConfig"
9652 }
9653 }
9654 },
9655 {
9656 "docs": {
9657 "stability": "stable",
9658 "summary": "Inspect the details of the metric object."
9659 },
9660 "locationInModule": {
9661 "filename": "lib/metric.ts",
9662 "line": 645
9663 },
9664 "name": "toMetricConfig",
9665 "overrides": "@aws-cdk/aws-cloudwatch.IMetric",
9666 "returns": {
9667 "type": {
9668 "fqn": "@aws-cdk/aws-cloudwatch.MetricConfig"
9669 }
9670 }
9671 },
9672 {
9673 "docs": {
9674 "stability": "stable",
9675 "summary": "Returns a string representation of an object."
9676 },
9677 "locationInModule": {
9678 "filename": "lib/metric.ts",
9679 "line": 684
9680 },
9681 "name": "toString",
9682 "returns": {
9683 "type": {
9684 "primitive": "string"
9685 }
9686 }
9687 },
9688 {
9689 "docs": {
9690 "remarks": "All properties except namespace and metricName can be changed.",
9691 "stability": "stable",
9692 "summary": "Return a copy of Metric with properties changed."
9693 },
9694 "locationInModule": {
9695 "filename": "lib/metric.ts",
9696 "line": 610
9697 },
9698 "name": "with",
9699 "parameters": [
9700 {
9701 "docs": {
9702 "summary": "The set of properties to change."
9703 },
9704 "name": "props",
9705 "type": {
9706 "fqn": "@aws-cdk/aws-cloudwatch.MathExpressionOptions"
9707 }
9708 }
9709 ],
9710 "returns": {
9711 "type": {
9712 "fqn": "@aws-cdk/aws-cloudwatch.MathExpression"
9713 }
9714 }
9715 }
9716 ],
9717 "name": "MathExpression",
9718 "properties": [
9719 {
9720 "docs": {
9721 "stability": "stable",
9722 "summary": "The expression defining the metric."
9723 },
9724 "immutable": true,
9725 "locationInModule": {
9726 "filename": "lib/metric.ts",
9727 "line": 527
9728 },
9729 "name": "expression",
9730 "type": {
9731 "primitive": "string"
9732 }
9733 },
9734 {
9735 "docs": {
9736 "stability": "stable",
9737 "summary": "Aggregation period of this metric."
9738 },
9739 "immutable": true,
9740 "locationInModule": {
9741 "filename": "lib/metric.ts",
9742 "line": 548
9743 },
9744 "name": "period",
9745 "type": {
9746 "fqn": "@aws-cdk/core.Duration"
9747 }
9748 },
9749 {
9750 "docs": {
9751 "stability": "stable",
9752 "summary": "The metrics used in the expression as KeyValuePair <id, metric>."
9753 },
9754 "immutable": true,
9755 "locationInModule": {
9756 "filename": "lib/metric.ts",
9757 "line": 532
9758 },
9759 "name": "usingMetrics",
9760 "type": {
9761 "collection": {
9762 "elementtype": {
9763 "fqn": "@aws-cdk/aws-cloudwatch.IMetric"
9764 },
9765 "kind": "map"
9766 }
9767 }
9768 },
9769 {
9770 "docs": {
9771 "stability": "stable",
9772 "summary": "The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The `Color` class has a set of standard colors that can be used here."
9773 },
9774 "immutable": true,
9775 "locationInModule": {
9776 "filename": "lib/metric.ts",
9777 "line": 543
9778 },
9779 "name": "color",
9780 "optional": true,
9781 "type": {
9782 "primitive": "string"
9783 }
9784 },
9785 {
9786 "docs": {
9787 "stability": "stable",
9788 "summary": "Label for this metric when added to a Graph."
9789 },
9790 "immutable": true,
9791 "locationInModule": {
9792 "filename": "lib/metric.ts",
9793 "line": 537
9794 },
9795 "name": "label",
9796 "optional": true,
9797 "type": {
9798 "primitive": "string"
9799 }
9800 },
9801 {
9802 "docs": {
9803 "stability": "stable",
9804 "summary": "Account to evaluate search expressions within."
9805 },
9806 "immutable": true,
9807 "locationInModule": {
9808 "filename": "lib/metric.ts",
9809 "line": 553
9810 },
9811 "name": "searchAccount",
9812 "optional": true,
9813 "type": {
9814 "primitive": "string"
9815 }
9816 },
9817 {
9818 "docs": {
9819 "stability": "stable",
9820 "summary": "Region to evaluate search expressions within."
9821 },
9822 "immutable": true,
9823 "locationInModule": {
9824 "filename": "lib/metric.ts",
9825 "line": 558
9826 },
9827 "name": "searchRegion",
9828 "optional": true,
9829 "type": {
9830 "primitive": "string"
9831 }
9832 },
9833 {
9834 "docs": {
9835 "stability": "stable",
9836 "summary": "Warnings generated by this math expression."
9837 },
9838 "immutable": true,
9839 "locationInModule": {
9840 "filename": "lib/metric.ts",
9841 "line": 563
9842 },
9843 "name": "warnings",
9844 "optional": true,
9845 "overrides": "@aws-cdk/aws-cloudwatch.IMetric",
9846 "type": {
9847 "collection": {
9848 "elementtype": {
9849 "primitive": "string"
9850 },
9851 "kind": "array"
9852 }
9853 }
9854 }
9855 ],
9856 "symbolId": "lib/metric:MathExpression"
9857 },
9858 "@aws-cdk/aws-cloudwatch.MathExpressionOptions": {
9859 "assembly": "@aws-cdk/aws-cloudwatch",
9860 "datatype": true,
9861 "docs": {
9862 "stability": "stable",
9863 "summary": "Configurable options for MathExpressions.",
9864 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nimport * as cdk from '@aws-cdk/core';\nconst mathExpressionOptions: cloudwatch.MathExpressionOptions = {\n color: 'color',\n label: 'label',\n period: cdk.Duration.minutes(30),\n searchAccount: 'searchAccount',\n searchRegion: 'searchRegion',\n};",
9865 "custom": {
9866 "exampleMetadata": "fixture=_generated"
9867 }
9868 },
9869 "fqn": "@aws-cdk/aws-cloudwatch.MathExpressionOptions",
9870 "kind": "interface",
9871 "locationInModule": {
9872 "filename": "lib/metric.ts",
9873 "line": 140
9874 },
9875 "name": "MathExpressionOptions",
9876 "properties": [
9877 {
9878 "abstract": true,
9879 "docs": {
9880 "default": "- Automatic color",
9881 "stability": "stable",
9882 "summary": "Color for this metric when added to a Graph in a Dashboard."
9883 },
9884 "immutable": true,
9885 "locationInModule": {
9886 "filename": "lib/metric.ts",
9887 "line": 174
9888 },
9889 "name": "color",
9890 "optional": true,
9891 "type": {
9892 "primitive": "string"
9893 }
9894 },
9895 {
9896 "abstract": true,
9897 "docs": {
9898 "default": "- Expression value is used as label",
9899 "remarks": "If this expression evaluates to more than one time series (for\nexample, through the use of `METRICS()` or `SEARCH()` expressions),\neach time series will appear in the graph using a combination of the\nexpression label and the individual metric label. Specify the empty\nstring (`''`) to suppress the expression label and only keep the\nmetric label.\n\nYou can use [dynamic labels](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html)\nto show summary information about the displayed time series\nin the legend. For example, if you use:\n\n```\n[max: ${MAX}] MyMetric\n```\n\nAs the metric label, the maximum value in the visible range will\nbe shown next to the time series name in the graph's legend. If the\nmath expression produces more than one time series, the maximum\nwill be shown for each individual time series produce by this\nmath expression.",
9900 "stability": "stable",
9901 "summary": "Label for this expression when added to a Graph in a Dashboard."
9902 },
9903 "immutable": true,
9904 "locationInModule": {
9905 "filename": "lib/metric.ts",
9906 "line": 167
9907 },
9908 "name": "label",
9909 "optional": true,
9910 "type": {
9911 "primitive": "string"
9912 }
9913 },
9914 {
9915 "abstract": true,
9916 "docs": {
9917 "default": "Duration.minutes(5)",
9918 "remarks": "This period overrides all periods in the metrics used in this\nmath expression.",
9919 "stability": "stable",
9920 "summary": "The period over which the expression's statistics are applied."
9921 },
9922 "immutable": true,
9923 "locationInModule": {
9924 "filename": "lib/metric.ts",
9925 "line": 184
9926 },
9927 "name": "period",
9928 "optional": true,
9929 "type": {
9930 "fqn": "@aws-cdk/core.Duration"
9931 }
9932 },
9933 {
9934 "abstract": true,
9935 "docs": {
9936 "default": "- Deployment account.",
9937 "remarks": "Specifying a searchAccount has no effect to the account used\nfor metrics within the expression (passed via usingMetrics).",
9938 "stability": "stable",
9939 "summary": "Account to evaluate search expressions within."
9940 },
9941 "immutable": true,
9942 "locationInModule": {
9943 "filename": "lib/metric.ts",
9944 "line": 194
9945 },
9946 "name": "searchAccount",
9947 "optional": true,
9948 "type": {
9949 "primitive": "string"
9950 }
9951 },
9952 {
9953 "abstract": true,
9954 "docs": {
9955 "default": "- Deployment region.",
9956 "remarks": "Specifying a searchRegion has no effect to the region used\nfor metrics within the expression (passed via usingMetrics).",
9957 "stability": "stable",
9958 "summary": "Region to evaluate search expressions within."
9959 },
9960 "immutable": true,
9961 "locationInModule": {
9962 "filename": "lib/metric.ts",
9963 "line": 204
9964 },
9965 "name": "searchRegion",
9966 "optional": true,
9967 "type": {
9968 "primitive": "string"
9969 }
9970 }
9971 ],
9972 "symbolId": "lib/metric:MathExpressionOptions"
9973 },
9974 "@aws-cdk/aws-cloudwatch.MathExpressionProps": {
9975 "assembly": "@aws-cdk/aws-cloudwatch",
9976 "datatype": true,
9977 "docs": {
9978 "custom": {
9979 "exampleMetadata": "infused"
9980 },
9981 "example": "declare const fn: lambda.Function;\n\nconst allProblems = new cloudwatch.MathExpression({\n expression: \"errors + throttles\",\n usingMetrics: {\n errors: fn.metricErrors(),\n faults: fn.metricThrottles(),\n }\n});",
9982 "stability": "stable",
9983 "summary": "Properties for a MathExpression."
9984 },
9985 "fqn": "@aws-cdk/aws-cloudwatch.MathExpressionProps",
9986 "interfaces": [
9987 "@aws-cdk/aws-cloudwatch.MathExpressionOptions"
9988 ],
9989 "kind": "interface",
9990 "locationInModule": {
9991 "filename": "lib/metric.ts",
9992 "line": 210
9993 },
9994 "name": "MathExpressionProps",
9995 "properties": [
9996 {
9997 "abstract": true,
9998 "docs": {
9999 "remarks": "When an expression contains a SEARCH function, it cannot be used\nwithin an Alarm.",
10000 "stability": "stable",
10001 "summary": "The expression defining the metric."
10002 },
10003 "immutable": true,
10004 "locationInModule": {
10005 "filename": "lib/metric.ts",
10006 "line": 217
10007 },
10008 "name": "expression",
10009 "type": {
10010 "primitive": "string"
10011 }
10012 },
10013 {
10014 "abstract": true,
10015 "docs": {
10016 "default": "- Empty map.",
10017 "remarks": "The key is the identifier that represents the given metric in the\nexpression, and the value is the actual Metric object.",
10018 "stability": "stable",
10019 "summary": "The metrics used in the expression, in a map."
10020 },
10021 "immutable": true,
10022 "locationInModule": {
10023 "filename": "lib/metric.ts",
10024 "line": 227
10025 },
10026 "name": "usingMetrics",
10027 "optional": true,
10028 "type": {
10029 "collection": {
10030 "elementtype": {
10031 "fqn": "@aws-cdk/aws-cloudwatch.IMetric"
10032 },
10033 "kind": "map"
10034 }
10035 }
10036 }
10037 ],
10038 "symbolId": "lib/metric:MathExpressionProps"
10039 },
10040 "@aws-cdk/aws-cloudwatch.Metric": {
10041 "assembly": "@aws-cdk/aws-cloudwatch",
10042 "docs": {
10043 "custom": {
10044 "exampleMetadata": "infused"
10045 },
10046 "example": "declare const fn: lambda.Function;\n\nconst minuteErrorRate = fn.metricErrors({\n statistic: 'avg',\n period: Duration.minutes(1),\n label: 'Lambda failure rate'\n});",
10047 "remarks": "The metric is a combination of a metric identifier (namespace, name and dimensions)\nand an aggregation function (statistic, period and unit).\n\nIt also contains metadata which is used only in graphs, such as color and label.\nIt makes sense to embed this in here, so that compound constructs can attach\nthat metadata to metrics they expose.\n\nThis class does not represent a resource, so hence is not a construct. Instead,\nMetric is an abstraction that makes it easy to specify metrics for use in both\nalarms and graphs.",
10048 "stability": "stable",
10049 "summary": "A metric emitted by a service."
10050 },
10051 "fqn": "@aws-cdk/aws-cloudwatch.Metric",
10052 "initializer": {
10053 "docs": {
10054 "stability": "stable"
10055 },
10056 "locationInModule": {
10057 "filename": "lib/metric.ts",
10058 "line": 285
10059 },
10060 "parameters": [
10061 {
10062 "name": "props",
10063 "type": {
10064 "fqn": "@aws-cdk/aws-cloudwatch.MetricProps"
10065 }
10066 }
10067 ]
10068 },
10069 "interfaces": [
10070 "@aws-cdk/aws-cloudwatch.IMetric"
10071 ],
10072 "kind": "class",
10073 "locationInModule": {
10074 "filename": "lib/metric.ts",
10075 "line": 244
10076 },
10077 "methods": [
10078 {
10079 "docs": {
10080 "stability": "stable",
10081 "summary": "Grant permissions to the given identity to write metrics."
10082 },
10083 "locationInModule": {
10084 "filename": "lib/metric.ts",
10085 "line": 250
10086 },
10087 "name": "grantPutMetricData",
10088 "parameters": [
10089 {
10090 "docs": {
10091 "summary": "The IAM identity to give permissions to."
10092 },
10093 "name": "grantee",
10094 "type": {
10095 "fqn": "@aws-cdk/aws-iam.IGrantable"
10096 }
10097 }
10098 ],
10099 "returns": {
10100 "type": {
10101 "fqn": "@aws-cdk/aws-iam.Grant"
10102 }
10103 },
10104 "static": true
10105 },
10106 {
10107 "docs": {
10108 "remarks": "Returns a Metric object that uses the account and region from the Stack\nthe given construct is defined in. If the metric is subsequently used\nin a Dashboard or Alarm in a different Stack defined in a different\naccount or region, the appropriate 'region' and 'account' fields\nwill be added to it.\n\nIf the scope we attach to is in an environment-agnostic stack,\nnothing is done and the same Metric object is returned.",
10109 "stability": "stable",
10110 "summary": "Attach the metric object to the given construct scope."
10111 },
10112 "locationInModule": {
10113 "filename": "lib/metric.ts",
10114 "line": 353
10115 },
10116 "name": "attachTo",
10117 "parameters": [
10118 {
10119 "name": "scope",
10120 "type": {
10121 "fqn": "constructs.IConstruct"
10122 }
10123 }
10124 ],
10125 "returns": {
10126 "type": {
10127 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
10128 }
10129 }
10130 },
10131 {
10132 "docs": {
10133 "remarks": "Combines both properties that may adjust the metric (aggregation) as well\nas alarm properties.",
10134 "stability": "stable",
10135 "summary": "Make a new Alarm for this metric."
10136 },
10137 "locationInModule": {
10138 "filename": "lib/metric.ts",
10139 "line": 435
10140 },
10141 "name": "createAlarm",
10142 "parameters": [
10143 {
10144 "name": "scope",
10145 "type": {
10146 "fqn": "@aws-cdk/core.Construct"
10147 }
10148 },
10149 {
10150 "name": "id",
10151 "type": {
10152 "primitive": "string"
10153 }
10154 },
10155 {
10156 "name": "props",
10157 "type": {
10158 "fqn": "@aws-cdk/aws-cloudwatch.CreateAlarmOptions"
10159 }
10160 }
10161 ],
10162 "returns": {
10163 "type": {
10164 "fqn": "@aws-cdk/aws-cloudwatch.Alarm"
10165 }
10166 }
10167 },
10168 {
10169 "docs": {
10170 "deprecated": "use toMetricConfig()",
10171 "stability": "deprecated",
10172 "summary": "Turn this metric object into an alarm configuration."
10173 },
10174 "locationInModule": {
10175 "filename": "lib/metric.ts",
10176 "line": 383
10177 },
10178 "name": "toAlarmConfig",
10179 "overrides": "@aws-cdk/aws-cloudwatch.IMetric",
10180 "returns": {
10181 "type": {
10182 "fqn": "@aws-cdk/aws-cloudwatch.MetricAlarmConfig"
10183 }
10184 }
10185 },
10186 {
10187 "docs": {
10188 "deprecated": "use toMetricConfig()",
10189 "stability": "deprecated",
10190 "summary": "Turn this metric object into a graph configuration."
10191 },
10192 "locationInModule": {
10193 "filename": "lib/metric.ts",
10194 "line": 404
10195 },
10196 "name": "toGraphConfig",
10197 "overrides": "@aws-cdk/aws-cloudwatch.IMetric",
10198 "returns": {
10199 "type": {
10200 "fqn": "@aws-cdk/aws-cloudwatch.MetricGraphConfig"
10201 }
10202 }
10203 },
10204 {
10205 "docs": {
10206 "stability": "stable",
10207 "summary": "Inspect the details of the metric object."
10208 },
10209 "locationInModule": {
10210 "filename": "lib/metric.ts",
10211 "line": 362
10212 },
10213 "name": "toMetricConfig",
10214 "overrides": "@aws-cdk/aws-cloudwatch.IMetric",
10215 "returns": {
10216 "type": {
10217 "fqn": "@aws-cdk/aws-cloudwatch.MetricConfig"
10218 }
10219 }
10220 },
10221 {
10222 "docs": {
10223 "stability": "stable",
10224 "summary": "Returns a string representation of an object."
10225 },
10226 "locationInModule": {
10227 "filename": "lib/metric.ts",
10228 "line": 453
10229 },
10230 "name": "toString",
10231 "returns": {
10232 "type": {
10233 "primitive": "string"
10234 }
10235 }
10236 },
10237 {
10238 "docs": {
10239 "remarks": "All properties except namespace and metricName can be changed.",
10240 "stability": "stable",
10241 "summary": "Return a copy of Metric `with` properties changed."
10242 },
10243 "locationInModule": {
10244 "filename": "lib/metric.ts",
10245 "line": 311
10246 },
10247 "name": "with",
10248 "parameters": [
10249 {
10250 "docs": {
10251 "summary": "The set of properties to change."
10252 },
10253 "name": "props",
10254 "type": {
10255 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
10256 }
10257 }
10258 ],
10259 "returns": {
10260 "type": {
10261 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
10262 }
10263 }
10264 }
10265 ],
10266 "name": "Metric",
10267 "properties": [
10268 {
10269 "docs": {
10270 "stability": "stable",
10271 "summary": "Name of this metric."
10272 },
10273 "immutable": true,
10274 "locationInModule": {
10275 "filename": "lib/metric.ts",
10276 "line": 263
10277 },
10278 "name": "metricName",
10279 "type": {
10280 "primitive": "string"
10281 }
10282 },
10283 {
10284 "docs": {
10285 "stability": "stable",
10286 "summary": "Namespace of this metric."
10287 },
10288 "immutable": true,
10289 "locationInModule": {
10290 "filename": "lib/metric.ts",
10291 "line": 261
10292 },
10293 "name": "namespace",
10294 "type": {
10295 "primitive": "string"
10296 }
10297 },
10298 {
10299 "docs": {
10300 "stability": "stable",
10301 "summary": "Period of this metric."
10302 },
10303 "immutable": true,
10304 "locationInModule": {
10305 "filename": "lib/metric.ts",
10306 "line": 265
10307 },
10308 "name": "period",
10309 "type": {
10310 "fqn": "@aws-cdk/core.Duration"
10311 }
10312 },
10313 {
10314 "docs": {
10315 "stability": "stable",
10316 "summary": "Statistic of this metric."
10317 },
10318 "immutable": true,
10319 "locationInModule": {
10320 "filename": "lib/metric.ts",
10321 "line": 267
10322 },
10323 "name": "statistic",
10324 "type": {
10325 "primitive": "string"
10326 }
10327 },
10328 {
10329 "docs": {
10330 "stability": "stable",
10331 "summary": "Account which this metric comes from."
10332 },
10333 "immutable": true,
10334 "locationInModule": {
10335 "filename": "lib/metric.ts",
10336 "line": 277
10337 },
10338 "name": "account",
10339 "optional": true,
10340 "type": {
10341 "primitive": "string"
10342 }
10343 },
10344 {
10345 "docs": {
10346 "stability": "stable",
10347 "summary": "The hex color code used when this metric is rendered on a graph."
10348 },
10349 "immutable": true,
10350 "locationInModule": {
10351 "filename": "lib/metric.ts",
10352 "line": 271
10353 },
10354 "name": "color",
10355 "optional": true,
10356 "type": {
10357 "primitive": "string"
10358 }
10359 },
10360 {
10361 "docs": {
10362 "stability": "stable",
10363 "summary": "Dimensions of this metric."
10364 },
10365 "immutable": true,
10366 "locationInModule": {
10367 "filename": "lib/metric.ts",
10368 "line": 259
10369 },
10370 "name": "dimensions",
10371 "optional": true,
10372 "type": {
10373 "collection": {
10374 "elementtype": {
10375 "primitive": "any"
10376 },
10377 "kind": "map"
10378 }
10379 }
10380 },
10381 {
10382 "docs": {
10383 "stability": "stable",
10384 "summary": "Label for this metric when added to a Graph in a Dashboard."
10385 },
10386 "immutable": true,
10387 "locationInModule": {
10388 "filename": "lib/metric.ts",
10389 "line": 269
10390 },
10391 "name": "label",
10392 "optional": true,
10393 "type": {
10394 "primitive": "string"
10395 }
10396 },
10397 {
10398 "docs": {
10399 "stability": "stable",
10400 "summary": "Region which this metric comes from."
10401 },
10402 "immutable": true,
10403 "locationInModule": {
10404 "filename": "lib/metric.ts",
10405 "line": 280
10406 },
10407 "name": "region",
10408 "optional": true,
10409 "type": {
10410 "primitive": "string"
10411 }
10412 },
10413 {
10414 "docs": {
10415 "stability": "stable",
10416 "summary": "Unit of the metric."
10417 },
10418 "immutable": true,
10419 "locationInModule": {
10420 "filename": "lib/metric.ts",
10421 "line": 274
10422 },
10423 "name": "unit",
10424 "optional": true,
10425 "type": {
10426 "fqn": "@aws-cdk/aws-cloudwatch.Unit"
10427 }
10428 },
10429 {
10430 "docs": {
10431 "stability": "stable",
10432 "summary": "Warnings attached to this metric."
10433 },
10434 "immutable": true,
10435 "locationInModule": {
10436 "filename": "lib/metric.ts",
10437 "line": 283
10438 },
10439 "name": "warnings",
10440 "optional": true,
10441 "overrides": "@aws-cdk/aws-cloudwatch.IMetric",
10442 "type": {
10443 "collection": {
10444 "elementtype": {
10445 "primitive": "string"
10446 },
10447 "kind": "array"
10448 }
10449 }
10450 }
10451 ],
10452 "symbolId": "lib/metric:Metric"
10453 },
10454 "@aws-cdk/aws-cloudwatch.MetricAlarmConfig": {
10455 "assembly": "@aws-cdk/aws-cloudwatch",
10456 "datatype": true,
10457 "docs": {
10458 "deprecated": "Replaced by MetricConfig",
10459 "stability": "deprecated",
10460 "summary": "Properties used to construct the Metric identifying part of an Alarm.",
10461 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\n\ndeclare const value: any;\nconst metricAlarmConfig: cloudwatch.MetricAlarmConfig = {\n metricName: 'metricName',\n namespace: 'namespace',\n period: 123,\n\n // the properties below are optional\n dimensions: [{\n name: 'name',\n value: value,\n }],\n extendedStatistic: 'extendedStatistic',\n statistic: cloudwatch.Statistic.SAMPLE_COUNT,\n unit: cloudwatch.Unit.SECONDS,\n};",
10462 "custom": {
10463 "exampleMetadata": "fixture=_generated"
10464 }
10465 },
10466 "fqn": "@aws-cdk/aws-cloudwatch.MetricAlarmConfig",
10467 "kind": "interface",
10468 "locationInModule": {
10469 "filename": "lib/metric-types.ts",
10470 "line": 355
10471 },
10472 "name": "MetricAlarmConfig",
10473 "properties": [
10474 {
10475 "abstract": true,
10476 "docs": {
10477 "stability": "deprecated",
10478 "summary": "Name of the metric."
10479 },
10480 "immutable": true,
10481 "locationInModule": {
10482 "filename": "lib/metric-types.ts",
10483 "line": 369
10484 },
10485 "name": "metricName",
10486 "type": {
10487 "primitive": "string"
10488 }
10489 },
10490 {
10491 "abstract": true,
10492 "docs": {
10493 "stability": "deprecated",
10494 "summary": "Namespace of the metric."
10495 },
10496 "immutable": true,
10497 "locationInModule": {
10498 "filename": "lib/metric-types.ts",
10499 "line": 364
10500 },
10501 "name": "namespace",
10502 "type": {
10503 "primitive": "string"
10504 }
10505 },
10506 {
10507 "abstract": true,
10508 "docs": {
10509 "stability": "deprecated",
10510 "summary": "How many seconds to aggregate over."
10511 },
10512 "immutable": true,
10513 "locationInModule": {
10514 "filename": "lib/metric-types.ts",
10515 "line": 374
10516 },
10517 "name": "period",
10518 "type": {
10519 "primitive": "number"
10520 }
10521 },
10522 {
10523 "abstract": true,
10524 "docs": {
10525 "stability": "deprecated",
10526 "summary": "The dimensions to apply to the alarm."
10527 },
10528 "immutable": true,
10529 "locationInModule": {
10530 "filename": "lib/metric-types.ts",
10531 "line": 359
10532 },
10533 "name": "dimensions",
10534 "optional": true,
10535 "type": {
10536 "collection": {
10537 "elementtype": {
10538 "fqn": "@aws-cdk/aws-cloudwatch.Dimension"
10539 },
10540 "kind": "array"
10541 }
10542 }
10543 },
10544 {
10545 "abstract": true,
10546 "docs": {
10547 "stability": "deprecated",
10548 "summary": "Percentile aggregation function to use."
10549 },
10550 "immutable": true,
10551 "locationInModule": {
10552 "filename": "lib/metric-types.ts",
10553 "line": 384
10554 },
10555 "name": "extendedStatistic",
10556 "optional": true,
10557 "type": {
10558 "primitive": "string"
10559 }
10560 },
10561 {
10562 "abstract": true,
10563 "docs": {
10564 "stability": "deprecated",
10565 "summary": "Simple aggregation function to use."
10566 },
10567 "immutable": true,
10568 "locationInModule": {
10569 "filename": "lib/metric-types.ts",
10570 "line": 379
10571 },
10572 "name": "statistic",
10573 "optional": true,
10574 "type": {
10575 "fqn": "@aws-cdk/aws-cloudwatch.Statistic"
10576 }
10577 },
10578 {
10579 "abstract": true,
10580 "docs": {
10581 "stability": "deprecated",
10582 "summary": "The unit of the alarm."
10583 },
10584 "immutable": true,
10585 "locationInModule": {
10586 "filename": "lib/metric-types.ts",
10587 "line": 389
10588 },
10589 "name": "unit",
10590 "optional": true,
10591 "type": {
10592 "fqn": "@aws-cdk/aws-cloudwatch.Unit"
10593 }
10594 }
10595 ],
10596 "symbolId": "lib/metric-types:MetricAlarmConfig"
10597 },
10598 "@aws-cdk/aws-cloudwatch.MetricConfig": {
10599 "assembly": "@aws-cdk/aws-cloudwatch",
10600 "datatype": true,
10601 "docs": {
10602 "stability": "stable",
10603 "summary": "Properties of a rendered metric.",
10604 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const metric: cloudwatch.Metric;\ndeclare const renderingProperties: any;\ndeclare const value: any;\nconst metricConfig: cloudwatch.MetricConfig = {\n mathExpression: {\n expression: 'expression',\n period: 123,\n usingMetrics: {\n usingMetricsKey: metric,\n },\n\n // the properties below are optional\n searchAccount: 'searchAccount',\n searchRegion: 'searchRegion',\n },\n metricStat: {\n metricName: 'metricName',\n namespace: 'namespace',\n period: cdk.Duration.minutes(30),\n statistic: 'statistic',\n\n // the properties below are optional\n account: 'account',\n dimensions: [{\n name: 'name',\n value: value,\n }],\n region: 'region',\n unitFilter: cloudwatch.Unit.SECONDS,\n },\n renderingProperties: {\n renderingPropertiesKey: renderingProperties,\n },\n};",
10605 "custom": {
10606 "exampleMetadata": "fixture=_generated"
10607 }
10608 },
10609 "fqn": "@aws-cdk/aws-cloudwatch.MetricConfig",
10610 "kind": "interface",
10611 "locationInModule": {
10612 "filename": "lib/metric-types.ts",
10613 "line": 227
10614 },
10615 "name": "MetricConfig",
10616 "properties": [
10617 {
10618 "abstract": true,
10619 "docs": {
10620 "default": "- None",
10621 "stability": "stable",
10622 "summary": "In case the metric is a math expression, the details of the math expression."
10623 },
10624 "immutable": true,
10625 "locationInModule": {
10626 "filename": "lib/metric-types.ts",
10627 "line": 240
10628 },
10629 "name": "mathExpression",
10630 "optional": true,
10631 "type": {
10632 "fqn": "@aws-cdk/aws-cloudwatch.MetricExpressionConfig"
10633 }
10634 },
10635 {
10636 "abstract": true,
10637 "docs": {
10638 "default": "- None",
10639 "stability": "stable",
10640 "summary": "In case the metric represents a query, the details of the query."
10641 },
10642 "immutable": true,
10643 "locationInModule": {
10644 "filename": "lib/metric-types.ts",
10645 "line": 233
10646 },
10647 "name": "metricStat",
10648 "optional": true,
10649 "type": {
10650 "fqn": "@aws-cdk/aws-cloudwatch.MetricStatConfig"
10651 }
10652 },
10653 {
10654 "abstract": true,
10655 "docs": {
10656 "default": "- None",
10657 "remarks": "Examples are 'label' and 'color', but any key in here will be\nadded to dashboard graphs.",
10658 "stability": "stable",
10659 "summary": "Additional properties which will be rendered if the metric is used in a dashboard."
10660 },
10661 "immutable": true,
10662 "locationInModule": {
10663 "filename": "lib/metric-types.ts",
10664 "line": 250
10665 },
10666 "name": "renderingProperties",
10667 "optional": true,
10668 "type": {
10669 "collection": {
10670 "elementtype": {
10671 "primitive": "any"
10672 },
10673 "kind": "map"
10674 }
10675 }
10676 }
10677 ],
10678 "symbolId": "lib/metric-types:MetricConfig"
10679 },
10680 "@aws-cdk/aws-cloudwatch.MetricExpressionConfig": {
10681 "assembly": "@aws-cdk/aws-cloudwatch",
10682 "datatype": true,
10683 "docs": {
10684 "stability": "stable",
10685 "summary": "Properties for a concrete metric.",
10686 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\n\ndeclare const metric: cloudwatch.Metric;\nconst metricExpressionConfig: cloudwatch.MetricExpressionConfig = {\n expression: 'expression',\n period: 123,\n usingMetrics: {\n usingMetricsKey: metric,\n },\n\n // the properties below are optional\n searchAccount: 'searchAccount',\n searchRegion: 'searchRegion',\n};",
10687 "custom": {
10688 "exampleMetadata": "fixture=_generated"
10689 }
10690 },
10691 "fqn": "@aws-cdk/aws-cloudwatch.MetricExpressionConfig",
10692 "kind": "interface",
10693 "locationInModule": {
10694 "filename": "lib/metric-types.ts",
10695 "line": 319
10696 },
10697 "name": "MetricExpressionConfig",
10698 "properties": [
10699 {
10700 "abstract": true,
10701 "docs": {
10702 "stability": "stable",
10703 "summary": "Math expression for the metric."
10704 },
10705 "immutable": true,
10706 "locationInModule": {
10707 "filename": "lib/metric-types.ts",
10708 "line": 323
10709 },
10710 "name": "expression",
10711 "type": {
10712 "primitive": "string"
10713 }
10714 },
10715 {
10716 "abstract": true,
10717 "docs": {
10718 "stability": "stable",
10719 "summary": "How many seconds to aggregate over."
10720 },
10721 "immutable": true,
10722 "locationInModule": {
10723 "filename": "lib/metric-types.ts",
10724 "line": 333
10725 },
10726 "name": "period",
10727 "type": {
10728 "primitive": "number"
10729 }
10730 },
10731 {
10732 "abstract": true,
10733 "docs": {
10734 "stability": "stable",
10735 "summary": "Metrics used in the math expression."
10736 },
10737 "immutable": true,
10738 "locationInModule": {
10739 "filename": "lib/metric-types.ts",
10740 "line": 328
10741 },
10742 "name": "usingMetrics",
10743 "type": {
10744 "collection": {
10745 "elementtype": {
10746 "fqn": "@aws-cdk/aws-cloudwatch.IMetric"
10747 },
10748 "kind": "map"
10749 }
10750 }
10751 },
10752 {
10753 "abstract": true,
10754 "docs": {
10755 "default": "- Deployment account.",
10756 "stability": "stable",
10757 "summary": "Account to evaluate search expressions within."
10758 },
10759 "immutable": true,
10760 "locationInModule": {
10761 "filename": "lib/metric-types.ts",
10762 "line": 340
10763 },
10764 "name": "searchAccount",
10765 "optional": true,
10766 "type": {
10767 "primitive": "string"
10768 }
10769 },
10770 {
10771 "abstract": true,
10772 "docs": {
10773 "default": "- Deployment region.",
10774 "stability": "stable",
10775 "summary": "Region to evaluate search expressions within."
10776 },
10777 "immutable": true,
10778 "locationInModule": {
10779 "filename": "lib/metric-types.ts",
10780 "line": 347
10781 },
10782 "name": "searchRegion",
10783 "optional": true,
10784 "type": {
10785 "primitive": "string"
10786 }
10787 }
10788 ],
10789 "symbolId": "lib/metric-types:MetricExpressionConfig"
10790 },
10791 "@aws-cdk/aws-cloudwatch.MetricGraphConfig": {
10792 "assembly": "@aws-cdk/aws-cloudwatch",
10793 "datatype": true,
10794 "docs": {
10795 "deprecated": "Replaced by MetricConfig",
10796 "stability": "deprecated",
10797 "summary": "Properties used to construct the Metric identifying part of a Graph.",
10798 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\n\ndeclare const value: any;\nconst metricGraphConfig: cloudwatch.MetricGraphConfig = {\n metricName: 'metricName',\n namespace: 'namespace',\n period: 123,\n renderingProperties: {\n period: 123,\n\n // the properties below are optional\n color: 'color',\n label: 'label',\n stat: 'stat',\n },\n\n // the properties below are optional\n color: 'color',\n dimensions: [{\n name: 'name',\n value: value,\n }],\n label: 'label',\n statistic: 'statistic',\n unit: cloudwatch.Unit.SECONDS,\n};",
10799 "custom": {
10800 "exampleMetadata": "fixture=_generated"
10801 }
10802 },
10803 "fqn": "@aws-cdk/aws-cloudwatch.MetricGraphConfig",
10804 "kind": "interface",
10805 "locationInModule": {
10806 "filename": "lib/metric-types.ts",
10807 "line": 397
10808 },
10809 "name": "MetricGraphConfig",
10810 "properties": [
10811 {
10812 "abstract": true,
10813 "docs": {
10814 "stability": "deprecated",
10815 "summary": "Name of the metric."
10816 },
10817 "immutable": true,
10818 "locationInModule": {
10819 "filename": "lib/metric-types.ts",
10820 "line": 411
10821 },
10822 "name": "metricName",
10823 "type": {
10824 "primitive": "string"
10825 }
10826 },
10827 {
10828 "abstract": true,
10829 "docs": {
10830 "stability": "deprecated",
10831 "summary": "Namespace of the metric."
10832 },
10833 "immutable": true,
10834 "locationInModule": {
10835 "filename": "lib/metric-types.ts",
10836 "line": 406
10837 },
10838 "name": "namespace",
10839 "type": {
10840 "primitive": "string"
10841 }
10842 },
10843 {
10844 "abstract": true,
10845 "docs": {
10846 "deprecated": "Use `period` in `renderingProperties`",
10847 "stability": "deprecated",
10848 "summary": "How many seconds to aggregate over."
10849 },
10850 "immutable": true,
10851 "locationInModule": {
10852 "filename": "lib/metric-types.ts",
10853 "line": 423
10854 },
10855 "name": "period",
10856 "type": {
10857 "primitive": "number"
10858 }
10859 },
10860 {
10861 "abstract": true,
10862 "docs": {
10863 "stability": "deprecated",
10864 "summary": "Rendering properties override yAxis parameter of the widget object."
10865 },
10866 "immutable": true,
10867 "locationInModule": {
10868 "filename": "lib/metric-types.ts",
10869 "line": 416
10870 },
10871 "name": "renderingProperties",
10872 "type": {
10873 "fqn": "@aws-cdk/aws-cloudwatch.MetricRenderingProperties"
10874 }
10875 },
10876 {
10877 "abstract": true,
10878 "docs": {
10879 "deprecated": "Use `color` in `renderingProperties`",
10880 "stability": "deprecated",
10881 "summary": "Color for the graph line."
10882 },
10883 "immutable": true,
10884 "locationInModule": {
10885 "filename": "lib/metric-types.ts",
10886 "line": 437
10887 },
10888 "name": "color",
10889 "optional": true,
10890 "type": {
10891 "primitive": "string"
10892 }
10893 },
10894 {
10895 "abstract": true,
10896 "docs": {
10897 "stability": "deprecated",
10898 "summary": "The dimensions to apply to the alarm."
10899 },
10900 "immutable": true,
10901 "locationInModule": {
10902 "filename": "lib/metric-types.ts",
10903 "line": 401
10904 },
10905 "name": "dimensions",
10906 "optional": true,
10907 "type": {
10908 "collection": {
10909 "elementtype": {
10910 "fqn": "@aws-cdk/aws-cloudwatch.Dimension"
10911 },
10912 "kind": "array"
10913 }
10914 }
10915 },
10916 {
10917 "abstract": true,
10918 "docs": {
10919 "deprecated": "Use `label` in `renderingProperties`",
10920 "stability": "deprecated",
10921 "summary": "Label for the metric."
10922 },
10923 "immutable": true,
10924 "locationInModule": {
10925 "filename": "lib/metric-types.ts",
10926 "line": 430
10927 },
10928 "name": "label",
10929 "optional": true,
10930 "type": {
10931 "primitive": "string"
10932 }
10933 },
10934 {
10935 "abstract": true,
10936 "docs": {
10937 "deprecated": "Use `stat` in `renderingProperties`",
10938 "stability": "deprecated",
10939 "summary": "Aggregation function to use (can be either simple or a percentile)."
10940 },
10941 "immutable": true,
10942 "locationInModule": {
10943 "filename": "lib/metric-types.ts",
10944 "line": 444
10945 },
10946 "name": "statistic",
10947 "optional": true,
10948 "type": {
10949 "primitive": "string"
10950 }
10951 },
10952 {
10953 "abstract": true,
10954 "docs": {
10955 "deprecated": "not used in dashboard widgets",
10956 "stability": "deprecated",
10957 "summary": "The unit of the alarm."
10958 },
10959 "immutable": true,
10960 "locationInModule": {
10961 "filename": "lib/metric-types.ts",
10962 "line": 451
10963 },
10964 "name": "unit",
10965 "optional": true,
10966 "type": {
10967 "fqn": "@aws-cdk/aws-cloudwatch.Unit"
10968 }
10969 }
10970 ],
10971 "symbolId": "lib/metric-types:MetricGraphConfig"
10972 },
10973 "@aws-cdk/aws-cloudwatch.MetricOptions": {
10974 "assembly": "@aws-cdk/aws-cloudwatch",
10975 "datatype": true,
10976 "docs": {
10977 "custom": {
10978 "exampleMetadata": "infused"
10979 },
10980 "example": "import * as cloudwatch from '@aws-cdk/aws-cloudwatch';\ndeclare const deliveryStream: firehose.DeliveryStream;\n\n// Alarm that triggers when the per-second average of incoming bytes exceeds 90% of the current service limit\nconst incomingBytesPercentOfLimit = new cloudwatch.MathExpression({\n expression: 'incomingBytes / 300 / bytePerSecLimit',\n usingMetrics: {\n incomingBytes: deliveryStream.metricIncomingBytes({ statistic: cloudwatch.Statistic.SUM }),\n bytePerSecLimit: deliveryStream.metric('BytesPerSecondLimit'),\n },\n});\n\nnew cloudwatch.Alarm(this, 'Alarm', {\n metric: incomingBytesPercentOfLimit,\n threshold: 0.9,\n evaluationPeriods: 3,\n});",
10981 "stability": "stable",
10982 "summary": "Properties of a metric that can be changed."
10983 },
10984 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions",
10985 "interfaces": [
10986 "@aws-cdk/aws-cloudwatch.CommonMetricOptions"
10987 ],
10988 "kind": "interface",
10989 "locationInModule": {
10990 "filename": "lib/metric.ts",
10991 "line": 134
10992 },
10993 "name": "MetricOptions",
10994 "symbolId": "lib/metric:MetricOptions"
10995 },
10996 "@aws-cdk/aws-cloudwatch.MetricProps": {
10997 "assembly": "@aws-cdk/aws-cloudwatch",
10998 "datatype": true,
10999 "docs": {
11000 "custom": {
11001 "exampleMetadata": "infused"
11002 },
11003 "example": "const hostedZone = new route53.HostedZone(this, 'MyHostedZone', { zoneName: \"example.org\" });\nconst metric = new cloudwatch.Metric({\n namespace: 'AWS/Route53',\n metricName: 'DNSQueries',\n dimensionsMap: {\n HostedZoneId: hostedZone.hostedZoneId\n }\n});",
11004 "stability": "stable",
11005 "summary": "Properties for a metric."
11006 },
11007 "fqn": "@aws-cdk/aws-cloudwatch.MetricProps",
11008 "interfaces": [
11009 "@aws-cdk/aws-cloudwatch.CommonMetricOptions"
11010 ],
11011 "kind": "interface",
11012 "locationInModule": {
11013 "filename": "lib/metric.ts",
11014 "line": 119
11015 },
11016 "name": "MetricProps",
11017 "properties": [
11018 {
11019 "abstract": true,
11020 "docs": {
11021 "stability": "stable",
11022 "summary": "Name of the metric."
11023 },
11024 "immutable": true,
11025 "locationInModule": {
11026 "filename": "lib/metric.ts",
11027 "line": 128
11028 },
11029 "name": "metricName",
11030 "type": {
11031 "primitive": "string"
11032 }
11033 },
11034 {
11035 "abstract": true,
11036 "docs": {
11037 "stability": "stable",
11038 "summary": "Namespace of the metric."
11039 },
11040 "immutable": true,
11041 "locationInModule": {
11042 "filename": "lib/metric.ts",
11043 "line": 123
11044 },
11045 "name": "namespace",
11046 "type": {
11047 "primitive": "string"
11048 }
11049 }
11050 ],
11051 "symbolId": "lib/metric:MetricProps"
11052 },
11053 "@aws-cdk/aws-cloudwatch.MetricRenderingProperties": {
11054 "assembly": "@aws-cdk/aws-cloudwatch",
11055 "datatype": true,
11056 "docs": {
11057 "deprecated": "Replaced by MetricConfig.",
11058 "stability": "deprecated",
11059 "summary": "Custom rendering properties that override the default rendering properties specified in the yAxis parameter of the widget object.",
11060 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst metricRenderingProperties: cloudwatch.MetricRenderingProperties = {\n period: 123,\n\n // the properties below are optional\n color: 'color',\n label: 'label',\n stat: 'stat',\n};",
11061 "custom": {
11062 "exampleMetadata": "fixture=_generated"
11063 }
11064 },
11065 "fqn": "@aws-cdk/aws-cloudwatch.MetricRenderingProperties",
11066 "kind": "interface",
11067 "locationInModule": {
11068 "filename": "lib/metric-types.ts",
11069 "line": 459
11070 },
11071 "name": "MetricRenderingProperties",
11072 "properties": [
11073 {
11074 "abstract": true,
11075 "docs": {
11076 "stability": "deprecated",
11077 "summary": "How many seconds to aggregate over."
11078 },
11079 "immutable": true,
11080 "locationInModule": {
11081 "filename": "lib/metric-types.ts",
11082 "line": 463
11083 },
11084 "name": "period",
11085 "type": {
11086 "primitive": "number"
11087 }
11088 },
11089 {
11090 "abstract": true,
11091 "docs": {
11092 "stability": "deprecated",
11093 "summary": "The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The `Color` class has a set of standard colors that can be used here."
11094 },
11095 "immutable": true,
11096 "locationInModule": {
11097 "filename": "lib/metric-types.ts",
11098 "line": 474
11099 },
11100 "name": "color",
11101 "optional": true,
11102 "type": {
11103 "primitive": "string"
11104 }
11105 },
11106 {
11107 "abstract": true,
11108 "docs": {
11109 "stability": "deprecated",
11110 "summary": "Label for the metric."
11111 },
11112 "immutable": true,
11113 "locationInModule": {
11114 "filename": "lib/metric-types.ts",
11115 "line": 468
11116 },
11117 "name": "label",
11118 "optional": true,
11119 "type": {
11120 "primitive": "string"
11121 }
11122 },
11123 {
11124 "abstract": true,
11125 "docs": {
11126 "stability": "deprecated",
11127 "summary": "Aggregation function to use (can be either simple or a percentile)."
11128 },
11129 "immutable": true,
11130 "locationInModule": {
11131 "filename": "lib/metric-types.ts",
11132 "line": 479
11133 },
11134 "name": "stat",
11135 "optional": true,
11136 "type": {
11137 "primitive": "string"
11138 }
11139 }
11140 ],
11141 "symbolId": "lib/metric-types:MetricRenderingProperties"
11142 },
11143 "@aws-cdk/aws-cloudwatch.MetricStatConfig": {
11144 "assembly": "@aws-cdk/aws-cloudwatch",
11145 "datatype": true,
11146 "docs": {
11147 "remarks": "NOTE: `unit` is no longer on this object since it is only used for `Alarms`, and doesn't mean what one\nwould expect it to mean there anyway. It is most likely to be misused.",
11148 "stability": "stable",
11149 "summary": "Properties for a concrete metric.",
11150 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const value: any;\nconst metricStatConfig: cloudwatch.MetricStatConfig = {\n metricName: 'metricName',\n namespace: 'namespace',\n period: cdk.Duration.minutes(30),\n statistic: 'statistic',\n\n // the properties below are optional\n account: 'account',\n dimensions: [{\n name: 'name',\n value: value,\n }],\n region: 'region',\n unitFilter: cloudwatch.Unit.SECONDS,\n};",
11151 "custom": {
11152 "exampleMetadata": "fixture=_generated"
11153 }
11154 },
11155 "fqn": "@aws-cdk/aws-cloudwatch.MetricStatConfig",
11156 "kind": "interface",
11157 "locationInModule": {
11158 "filename": "lib/metric-types.ts",
11159 "line": 259
11160 },
11161 "name": "MetricStatConfig",
11162 "properties": [
11163 {
11164 "abstract": true,
11165 "docs": {
11166 "stability": "stable",
11167 "summary": "Name of the metric."
11168 },
11169 "immutable": true,
11170 "locationInModule": {
11171 "filename": "lib/metric-types.ts",
11172 "line": 275
11173 },
11174 "name": "metricName",
11175 "type": {
11176 "primitive": "string"
11177 }
11178 },
11179 {
11180 "abstract": true,
11181 "docs": {
11182 "stability": "stable",
11183 "summary": "Namespace of the metric."
11184 },
11185 "immutable": true,
11186 "locationInModule": {
11187 "filename": "lib/metric-types.ts",
11188 "line": 270
11189 },
11190 "name": "namespace",
11191 "type": {
11192 "primitive": "string"
11193 }
11194 },
11195 {
11196 "abstract": true,
11197 "docs": {
11198 "stability": "stable",
11199 "summary": "How many seconds to aggregate over."
11200 },
11201 "immutable": true,
11202 "locationInModule": {
11203 "filename": "lib/metric-types.ts",
11204 "line": 280
11205 },
11206 "name": "period",
11207 "type": {
11208 "fqn": "@aws-cdk/core.Duration"
11209 }
11210 },
11211 {
11212 "abstract": true,
11213 "docs": {
11214 "stability": "stable",
11215 "summary": "Aggregation function to use (can be either simple or a percentile)."
11216 },
11217 "immutable": true,
11218 "locationInModule": {
11219 "filename": "lib/metric-types.ts",
11220 "line": 285
11221 },
11222 "name": "statistic",
11223 "type": {
11224 "primitive": "string"
11225 }
11226 },
11227 {
11228 "abstract": true,
11229 "docs": {
11230 "default": "Deployment account.",
11231 "stability": "stable",
11232 "summary": "Account which this metric comes from."
11233 },
11234 "immutable": true,
11235 "locationInModule": {
11236 "filename": "lib/metric-types.ts",
11237 "line": 313
11238 },
11239 "name": "account",
11240 "optional": true,
11241 "type": {
11242 "primitive": "string"
11243 }
11244 },
11245 {
11246 "abstract": true,
11247 "docs": {
11248 "default": "[]",
11249 "stability": "stable",
11250 "summary": "The dimensions to apply to the alarm."
11251 },
11252 "immutable": true,
11253 "locationInModule": {
11254 "filename": "lib/metric-types.ts",
11255 "line": 265
11256 },
11257 "name": "dimensions",
11258 "optional": true,
11259 "type": {
11260 "collection": {
11261 "elementtype": {
11262 "fqn": "@aws-cdk/aws-cloudwatch.Dimension"
11263 },
11264 "kind": "array"
11265 }
11266 }
11267 },
11268 {
11269 "abstract": true,
11270 "docs": {
11271 "default": "Deployment region.",
11272 "stability": "stable",
11273 "summary": "Region which this metric comes from."
11274 },
11275 "immutable": true,
11276 "locationInModule": {
11277 "filename": "lib/metric-types.ts",
11278 "line": 306
11279 },
11280 "name": "region",
11281 "optional": true,
11282 "type": {
11283 "primitive": "string"
11284 }
11285 },
11286 {
11287 "abstract": true,
11288 "docs": {
11289 "default": "- Refer to all metric datums",
11290 "remarks": "Only refer to datums emitted to the metric stream with the given unit and\nignore all others. Only useful when datums are being emitted to the same\nmetric stream under different units.\n\nThis field has been renamed from plain `unit` to clearly communicate\nits purpose.",
11291 "stability": "stable",
11292 "summary": "Unit used to filter the metric stream."
11293 },
11294 "immutable": true,
11295 "locationInModule": {
11296 "filename": "lib/metric-types.ts",
11297 "line": 299
11298 },
11299 "name": "unitFilter",
11300 "optional": true,
11301 "type": {
11302 "fqn": "@aws-cdk/aws-cloudwatch.Unit"
11303 }
11304 }
11305 ],
11306 "symbolId": "lib/metric-types:MetricStatConfig"
11307 },
11308 "@aws-cdk/aws-cloudwatch.MetricWidgetProps": {
11309 "assembly": "@aws-cdk/aws-cloudwatch",
11310 "datatype": true,
11311 "docs": {
11312 "stability": "stable",
11313 "summary": "Basic properties for widgets that display metrics.",
11314 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst metricWidgetProps: cloudwatch.MetricWidgetProps = {\n height: 123,\n region: 'region',\n title: 'title',\n width: 123,\n};",
11315 "custom": {
11316 "exampleMetadata": "fixture=_generated"
11317 }
11318 },
11319 "fqn": "@aws-cdk/aws-cloudwatch.MetricWidgetProps",
11320 "kind": "interface",
11321 "locationInModule": {
11322 "filename": "lib/graph.ts",
11323 "line": 10
11324 },
11325 "name": "MetricWidgetProps",
11326 "properties": [
11327 {
11328 "abstract": true,
11329 "docs": {
11330 "default": "- 6 for Alarm and Graph widgets.\n3 for single value widgets where most recent value of a metric is displayed.",
11331 "stability": "stable",
11332 "summary": "Height of the widget."
11333 },
11334 "immutable": true,
11335 "locationInModule": {
11336 "filename": "lib/graph.ts",
11337 "line": 38
11338 },
11339 "name": "height",
11340 "optional": true,
11341 "type": {
11342 "primitive": "number"
11343 }
11344 },
11345 {
11346 "abstract": true,
11347 "docs": {
11348 "default": "- Current region",
11349 "stability": "stable",
11350 "summary": "The region the metrics of this graph should be taken from."
11351 },
11352 "immutable": true,
11353 "locationInModule": {
11354 "filename": "lib/graph.ts",
11355 "line": 23
11356 },
11357 "name": "region",
11358 "optional": true,
11359 "type": {
11360 "primitive": "string"
11361 }
11362 },
11363 {
11364 "abstract": true,
11365 "docs": {
11366 "default": "- None",
11367 "stability": "stable",
11368 "summary": "Title for the graph."
11369 },
11370 "immutable": true,
11371 "locationInModule": {
11372 "filename": "lib/graph.ts",
11373 "line": 16
11374 },
11375 "name": "title",
11376 "optional": true,
11377 "type": {
11378 "primitive": "string"
11379 }
11380 },
11381 {
11382 "abstract": true,
11383 "docs": {
11384 "default": "6",
11385 "stability": "stable",
11386 "summary": "Width of the widget, in a grid of 24 units wide."
11387 },
11388 "immutable": true,
11389 "locationInModule": {
11390 "filename": "lib/graph.ts",
11391 "line": 30
11392 },
11393 "name": "width",
11394 "optional": true,
11395 "type": {
11396 "primitive": "number"
11397 }
11398 }
11399 ],
11400 "symbolId": "lib/graph:MetricWidgetProps"
11401 },
11402 "@aws-cdk/aws-cloudwatch.PeriodOverride": {
11403 "assembly": "@aws-cdk/aws-cloudwatch",
11404 "docs": {
11405 "stability": "stable",
11406 "summary": "Specify the period for graphs when the CloudWatch dashboard loads."
11407 },
11408 "fqn": "@aws-cdk/aws-cloudwatch.PeriodOverride",
11409 "kind": "enum",
11410 "locationInModule": {
11411 "filename": "lib/dashboard.ts",
11412 "line": 10
11413 },
11414 "members": [
11415 {
11416 "docs": {
11417 "stability": "stable",
11418 "summary": "Period of all graphs on the dashboard automatically adapt to the time range of the dashboard."
11419 },
11420 "name": "AUTO"
11421 },
11422 {
11423 "docs": {
11424 "stability": "stable",
11425 "summary": "Period set for each graph will be used."
11426 },
11427 "name": "INHERIT"
11428 }
11429 ],
11430 "name": "PeriodOverride",
11431 "symbolId": "lib/dashboard:PeriodOverride"
11432 },
11433 "@aws-cdk/aws-cloudwatch.Row": {
11434 "assembly": "@aws-cdk/aws-cloudwatch",
11435 "docs": {
11436 "remarks": "Widgets will be laid out next to each other",
11437 "stability": "stable",
11438 "summary": "A widget that contains other widgets in a horizontal row.",
11439 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\n\ndeclare const widget: cloudwatch.IWidget;\nconst row = new cloudwatch.Row(widget);",
11440 "custom": {
11441 "exampleMetadata": "fixture=_generated"
11442 }
11443 },
11444 "fqn": "@aws-cdk/aws-cloudwatch.Row",
11445 "initializer": {
11446 "docs": {
11447 "stability": "stable"
11448 },
11449 "locationInModule": {
11450 "filename": "lib/layout.ts",
11451 "line": 24
11452 },
11453 "parameters": [
11454 {
11455 "name": "widgets",
11456 "type": {
11457 "fqn": "@aws-cdk/aws-cloudwatch.IWidget"
11458 },
11459 "variadic": true
11460 }
11461 ],
11462 "variadic": true
11463 },
11464 "interfaces": [
11465 "@aws-cdk/aws-cloudwatch.IWidget"
11466 ],
11467 "kind": "class",
11468 "locationInModule": {
11469 "filename": "lib/layout.ts",
11470 "line": 10
11471 },
11472 "methods": [
11473 {
11474 "docs": {
11475 "stability": "stable",
11476 "summary": "Place the widget at a given position."
11477 },
11478 "locationInModule": {
11479 "filename": "lib/layout.ts",
11480 "line": 46
11481 },
11482 "name": "position",
11483 "overrides": "@aws-cdk/aws-cloudwatch.IWidget",
11484 "parameters": [
11485 {
11486 "name": "x",
11487 "type": {
11488 "primitive": "number"
11489 }
11490 },
11491 {
11492 "name": "y",
11493 "type": {
11494 "primitive": "number"
11495 }
11496 }
11497 ]
11498 },
11499 {
11500 "docs": {
11501 "stability": "stable",
11502 "summary": "Return the widget JSON for use in the dashboard."
11503 },
11504 "locationInModule": {
11505 "filename": "lib/layout.ts",
11506 "line": 52
11507 },
11508 "name": "toJson",
11509 "overrides": "@aws-cdk/aws-cloudwatch.IWidget",
11510 "returns": {
11511 "type": {
11512 "collection": {
11513 "elementtype": {
11514 "primitive": "any"
11515 },
11516 "kind": "array"
11517 }
11518 }
11519 }
11520 }
11521 ],
11522 "name": "Row",
11523 "properties": [
11524 {
11525 "docs": {
11526 "stability": "stable",
11527 "summary": "The amount of vertical grid units the widget will take up."
11528 },
11529 "immutable": true,
11530 "locationInModule": {
11531 "filename": "lib/layout.ts",
11532 "line": 12
11533 },
11534 "name": "height",
11535 "overrides": "@aws-cdk/aws-cloudwatch.IWidget",
11536 "type": {
11537 "primitive": "number"
11538 }
11539 },
11540 {
11541 "docs": {
11542 "stability": "stable",
11543 "summary": "List of contained widgets."
11544 },
11545 "immutable": true,
11546 "locationInModule": {
11547 "filename": "lib/layout.ts",
11548 "line": 17
11549 },
11550 "name": "widgets",
11551 "type": {
11552 "collection": {
11553 "elementtype": {
11554 "fqn": "@aws-cdk/aws-cloudwatch.IWidget"
11555 },
11556 "kind": "array"
11557 }
11558 }
11559 },
11560 {
11561 "docs": {
11562 "stability": "stable",
11563 "summary": "The amount of horizontal grid units the widget will take up."
11564 },
11565 "immutable": true,
11566 "locationInModule": {
11567 "filename": "lib/layout.ts",
11568 "line": 11
11569 },
11570 "name": "width",
11571 "overrides": "@aws-cdk/aws-cloudwatch.IWidget",
11572 "type": {
11573 "primitive": "number"
11574 }
11575 }
11576 ],
11577 "symbolId": "lib/layout:Row"
11578 },
11579 "@aws-cdk/aws-cloudwatch.Shading": {
11580 "assembly": "@aws-cdk/aws-cloudwatch",
11581 "docs": {
11582 "stability": "stable",
11583 "summary": "Fill shading options that will be used with an annotation."
11584 },
11585 "fqn": "@aws-cdk/aws-cloudwatch.Shading",
11586 "kind": "enum",
11587 "locationInModule": {
11588 "filename": "lib/graph.ts",
11589 "line": 504
11590 },
11591 "members": [
11592 {
11593 "docs": {
11594 "stability": "stable",
11595 "summary": "Don't add shading."
11596 },
11597 "name": "NONE"
11598 },
11599 {
11600 "docs": {
11601 "stability": "stable",
11602 "summary": "Add shading above the annotation."
11603 },
11604 "name": "ABOVE"
11605 },
11606 {
11607 "docs": {
11608 "stability": "stable",
11609 "summary": "Add shading below the annotation."
11610 },
11611 "name": "BELOW"
11612 }
11613 ],
11614 "name": "Shading",
11615 "symbolId": "lib/graph:Shading"
11616 },
11617 "@aws-cdk/aws-cloudwatch.SingleValueWidget": {
11618 "assembly": "@aws-cdk/aws-cloudwatch",
11619 "base": "@aws-cdk/aws-cloudwatch.ConcreteWidget",
11620 "docs": {
11621 "custom": {
11622 "exampleMetadata": "infused"
11623 },
11624 "example": "declare const dashboard: cloudwatch.Dashboard;\ndeclare const visitorCount: cloudwatch.Metric;\ndeclare const purchaseCount: cloudwatch.Metric;\n\ndashboard.addWidgets(new cloudwatch.SingleValueWidget({\n metrics: [visitorCount, purchaseCount],\n}));",
11625 "stability": "stable",
11626 "summary": "A dashboard widget that displays the most recent value for every metric."
11627 },
11628 "fqn": "@aws-cdk/aws-cloudwatch.SingleValueWidget",
11629 "initializer": {
11630 "docs": {
11631 "stability": "stable"
11632 },
11633 "locationInModule": {
11634 "filename": "lib/graph.ts",
11635 "line": 346
11636 },
11637 "parameters": [
11638 {
11639 "name": "props",
11640 "type": {
11641 "fqn": "@aws-cdk/aws-cloudwatch.SingleValueWidgetProps"
11642 }
11643 }
11644 ]
11645 },
11646 "kind": "class",
11647 "locationInModule": {
11648 "filename": "lib/graph.ts",
11649 "line": 343
11650 },
11651 "methods": [
11652 {
11653 "docs": {
11654 "stability": "stable",
11655 "summary": "Return the widget JSON for use in the dashboard."
11656 },
11657 "locationInModule": {
11658 "filename": "lib/graph.ts",
11659 "line": 352
11660 },
11661 "name": "toJson",
11662 "overrides": "@aws-cdk/aws-cloudwatch.ConcreteWidget",
11663 "returns": {
11664 "type": {
11665 "collection": {
11666 "elementtype": {
11667 "primitive": "any"
11668 },
11669 "kind": "array"
11670 }
11671 }
11672 }
11673 }
11674 ],
11675 "name": "SingleValueWidget",
11676 "symbolId": "lib/graph:SingleValueWidget"
11677 },
11678 "@aws-cdk/aws-cloudwatch.SingleValueWidgetProps": {
11679 "assembly": "@aws-cdk/aws-cloudwatch",
11680 "datatype": true,
11681 "docs": {
11682 "custom": {
11683 "exampleMetadata": "infused"
11684 },
11685 "example": "declare const dashboard: cloudwatch.Dashboard;\ndeclare const visitorCount: cloudwatch.Metric;\ndeclare const purchaseCount: cloudwatch.Metric;\n\ndashboard.addWidgets(new cloudwatch.SingleValueWidget({\n metrics: [visitorCount, purchaseCount],\n}));",
11686 "stability": "stable",
11687 "summary": "Properties for a SingleValueWidget."
11688 },
11689 "fqn": "@aws-cdk/aws-cloudwatch.SingleValueWidgetProps",
11690 "interfaces": [
11691 "@aws-cdk/aws-cloudwatch.MetricWidgetProps"
11692 ],
11693 "kind": "interface",
11694 "locationInModule": {
11695 "filename": "lib/graph.ts",
11696 "line": 319
11697 },
11698 "name": "SingleValueWidgetProps",
11699 "properties": [
11700 {
11701 "abstract": true,
11702 "docs": {
11703 "stability": "stable",
11704 "summary": "Metrics to display."
11705 },
11706 "immutable": true,
11707 "locationInModule": {
11708 "filename": "lib/graph.ts",
11709 "line": 323
11710 },
11711 "name": "metrics",
11712 "type": {
11713 "collection": {
11714 "elementtype": {
11715 "fqn": "@aws-cdk/aws-cloudwatch.IMetric"
11716 },
11717 "kind": "array"
11718 }
11719 }
11720 },
11721 {
11722 "abstract": true,
11723 "docs": {
11724 "default": "false",
11725 "stability": "stable",
11726 "summary": "Whether to show as many digits as can fit, before rounding."
11727 },
11728 "immutable": true,
11729 "locationInModule": {
11730 "filename": "lib/graph.ts",
11731 "line": 337
11732 },
11733 "name": "fullPrecision",
11734 "optional": true,
11735 "type": {
11736 "primitive": "boolean"
11737 }
11738 },
11739 {
11740 "abstract": true,
11741 "docs": {
11742 "default": "false",
11743 "stability": "stable",
11744 "summary": "Whether to show the value from the entire time range."
11745 },
11746 "immutable": true,
11747 "locationInModule": {
11748 "filename": "lib/graph.ts",
11749 "line": 330
11750 },
11751 "name": "setPeriodToTimeRange",
11752 "optional": true,
11753 "type": {
11754 "primitive": "boolean"
11755 }
11756 }
11757 ],
11758 "symbolId": "lib/graph:SingleValueWidgetProps"
11759 },
11760 "@aws-cdk/aws-cloudwatch.Spacer": {
11761 "assembly": "@aws-cdk/aws-cloudwatch",
11762 "docs": {
11763 "stability": "stable",
11764 "summary": "A widget that doesn't display anything but takes up space.",
11765 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst spacer = new cloudwatch.Spacer(/* all optional props */ {\n height: 123,\n width: 123,\n});",
11766 "custom": {
11767 "exampleMetadata": "fixture=_generated"
11768 }
11769 },
11770 "fqn": "@aws-cdk/aws-cloudwatch.Spacer",
11771 "initializer": {
11772 "docs": {
11773 "stability": "stable"
11774 },
11775 "locationInModule": {
11776 "filename": "lib/layout.ts",
11777 "line": 126
11778 },
11779 "parameters": [
11780 {
11781 "name": "props",
11782 "optional": true,
11783 "type": {
11784 "fqn": "@aws-cdk/aws-cloudwatch.SpacerProps"
11785 }
11786 }
11787 ]
11788 },
11789 "interfaces": [
11790 "@aws-cdk/aws-cloudwatch.IWidget"
11791 ],
11792 "kind": "class",
11793 "locationInModule": {
11794 "filename": "lib/layout.ts",
11795 "line": 122
11796 },
11797 "methods": [
11798 {
11799 "docs": {
11800 "stability": "stable",
11801 "summary": "Place the widget at a given position."
11802 },
11803 "locationInModule": {
11804 "filename": "lib/layout.ts",
11805 "line": 131
11806 },
11807 "name": "position",
11808 "overrides": "@aws-cdk/aws-cloudwatch.IWidget",
11809 "parameters": [
11810 {
11811 "name": "_x",
11812 "type": {
11813 "primitive": "number"
11814 }
11815 },
11816 {
11817 "name": "_y",
11818 "type": {
11819 "primitive": "number"
11820 }
11821 }
11822 ]
11823 },
11824 {
11825 "docs": {
11826 "stability": "stable",
11827 "summary": "Return the widget JSON for use in the dashboard."
11828 },
11829 "locationInModule": {
11830 "filename": "lib/layout.ts",
11831 "line": 135
11832 },
11833 "name": "toJson",
11834 "overrides": "@aws-cdk/aws-cloudwatch.IWidget",
11835 "returns": {
11836 "type": {
11837 "collection": {
11838 "elementtype": {
11839 "primitive": "any"
11840 },
11841 "kind": "array"
11842 }
11843 }
11844 }
11845 }
11846 ],
11847 "name": "Spacer",
11848 "properties": [
11849 {
11850 "docs": {
11851 "stability": "stable",
11852 "summary": "The amount of vertical grid units the widget will take up."
11853 },
11854 "immutable": true,
11855 "locationInModule": {
11856 "filename": "lib/layout.ts",
11857 "line": 124
11858 },
11859 "name": "height",
11860 "overrides": "@aws-cdk/aws-cloudwatch.IWidget",
11861 "type": {
11862 "primitive": "number"
11863 }
11864 },
11865 {
11866 "docs": {
11867 "stability": "stable",
11868 "summary": "The amount of horizontal grid units the widget will take up."
11869 },
11870 "immutable": true,
11871 "locationInModule": {
11872 "filename": "lib/layout.ts",
11873 "line": 123
11874 },
11875 "name": "width",
11876 "overrides": "@aws-cdk/aws-cloudwatch.IWidget",
11877 "type": {
11878 "primitive": "number"
11879 }
11880 }
11881 ],
11882 "symbolId": "lib/layout:Spacer"
11883 },
11884 "@aws-cdk/aws-cloudwatch.SpacerProps": {
11885 "assembly": "@aws-cdk/aws-cloudwatch",
11886 "datatype": true,
11887 "docs": {
11888 "stability": "stable",
11889 "summary": "Props of the spacer.",
11890 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst spacerProps: cloudwatch.SpacerProps = {\n height: 123,\n width: 123,\n};",
11891 "custom": {
11892 "exampleMetadata": "fixture=_generated"
11893 }
11894 },
11895 "fqn": "@aws-cdk/aws-cloudwatch.SpacerProps",
11896 "kind": "interface",
11897 "locationInModule": {
11898 "filename": "lib/layout.ts",
11899 "line": 103
11900 },
11901 "name": "SpacerProps",
11902 "properties": [
11903 {
11904 "abstract": true,
11905 "docs": {
11906 "default": ": 1",
11907 "stability": "stable",
11908 "summary": "Height of the spacer."
11909 },
11910 "immutable": true,
11911 "locationInModule": {
11912 "filename": "lib/layout.ts",
11913 "line": 116
11914 },
11915 "name": "height",
11916 "optional": true,
11917 "type": {
11918 "primitive": "number"
11919 }
11920 },
11921 {
11922 "abstract": true,
11923 "docs": {
11924 "default": "1",
11925 "stability": "stable",
11926 "summary": "Width of the spacer."
11927 },
11928 "immutable": true,
11929 "locationInModule": {
11930 "filename": "lib/layout.ts",
11931 "line": 109
11932 },
11933 "name": "width",
11934 "optional": true,
11935 "type": {
11936 "primitive": "number"
11937 }
11938 }
11939 ],
11940 "symbolId": "lib/layout:SpacerProps"
11941 },
11942 "@aws-cdk/aws-cloudwatch.Statistic": {
11943 "assembly": "@aws-cdk/aws-cloudwatch",
11944 "docs": {
11945 "custom": {
11946 "exampleMetadata": "infused"
11947 },
11948 "example": "import * as cloudwatch from '@aws-cdk/aws-cloudwatch';\ndeclare const deliveryStream: firehose.DeliveryStream;\n\n// Alarm that triggers when the per-second average of incoming bytes exceeds 90% of the current service limit\nconst incomingBytesPercentOfLimit = new cloudwatch.MathExpression({\n expression: 'incomingBytes / 300 / bytePerSecLimit',\n usingMetrics: {\n incomingBytes: deliveryStream.metricIncomingBytes({ statistic: cloudwatch.Statistic.SUM }),\n bytePerSecLimit: deliveryStream.metric('BytesPerSecondLimit'),\n },\n});\n\nnew cloudwatch.Alarm(this, 'Alarm', {\n metric: incomingBytesPercentOfLimit,\n threshold: 0.9,\n evaluationPeriods: 3,\n});",
11949 "stability": "stable",
11950 "summary": "Statistic to use over the aggregation period."
11951 },
11952 "fqn": "@aws-cdk/aws-cloudwatch.Statistic",
11953 "kind": "enum",
11954 "locationInModule": {
11955 "filename": "lib/metric-types.ts",
11956 "line": 57
11957 },
11958 "members": [
11959 {
11960 "docs": {
11961 "stability": "stable",
11962 "summary": "The count (number) of data points used for the statistical calculation."
11963 },
11964 "name": "SAMPLE_COUNT"
11965 },
11966 {
11967 "docs": {
11968 "stability": "stable",
11969 "summary": "The value of Sum / SampleCount during the specified period."
11970 },
11971 "name": "AVERAGE"
11972 },
11973 {
11974 "docs": {
11975 "remarks": "This statistic can be useful for determining the total volume of a metric.",
11976 "stability": "stable",
11977 "summary": "All values submitted for the matching metric added together."
11978 },
11979 "name": "SUM"
11980 },
11981 {
11982 "docs": {
11983 "remarks": "You can use this value to determine low volumes of activity for your application.",
11984 "stability": "stable",
11985 "summary": "The lowest value observed during the specified period."
11986 },
11987 "name": "MINIMUM"
11988 },
11989 {
11990 "docs": {
11991 "remarks": "You can use this value to determine high volumes of activity for your application.",
11992 "stability": "stable",
11993 "summary": "The highest value observed during the specified period."
11994 },
11995 "name": "MAXIMUM"
11996 }
11997 ],
11998 "name": "Statistic",
11999 "symbolId": "lib/metric-types:Statistic"
12000 },
12001 "@aws-cdk/aws-cloudwatch.TextWidget": {
12002 "assembly": "@aws-cdk/aws-cloudwatch",
12003 "base": "@aws-cdk/aws-cloudwatch.ConcreteWidget",
12004 "docs": {
12005 "custom": {
12006 "exampleMetadata": "infused"
12007 },
12008 "example": "declare const dashboard: cloudwatch.Dashboard;\n\ndashboard.addWidgets(new cloudwatch.TextWidget({\n markdown: '# Key Performance Indicators'\n}));",
12009 "stability": "stable",
12010 "summary": "A dashboard widget that displays MarkDown."
12011 },
12012 "fqn": "@aws-cdk/aws-cloudwatch.TextWidget",
12013 "initializer": {
12014 "docs": {
12015 "stability": "stable"
12016 },
12017 "locationInModule": {
12018 "filename": "lib/text.ts",
12019 "line": 33
12020 },
12021 "parameters": [
12022 {
12023 "name": "props",
12024 "type": {
12025 "fqn": "@aws-cdk/aws-cloudwatch.TextWidgetProps"
12026 }
12027 }
12028 ]
12029 },
12030 "kind": "class",
12031 "locationInModule": {
12032 "filename": "lib/text.ts",
12033 "line": 30
12034 },
12035 "methods": [
12036 {
12037 "docs": {
12038 "stability": "stable",
12039 "summary": "Place the widget at a given position."
12040 },
12041 "locationInModule": {
12042 "filename": "lib/text.ts",
12043 "line": 38
12044 },
12045 "name": "position",
12046 "overrides": "@aws-cdk/aws-cloudwatch.ConcreteWidget",
12047 "parameters": [
12048 {
12049 "name": "x",
12050 "type": {
12051 "primitive": "number"
12052 }
12053 },
12054 {
12055 "name": "y",
12056 "type": {
12057 "primitive": "number"
12058 }
12059 }
12060 ]
12061 },
12062 {
12063 "docs": {
12064 "stability": "stable",
12065 "summary": "Return the widget JSON for use in the dashboard."
12066 },
12067 "locationInModule": {
12068 "filename": "lib/text.ts",
12069 "line": 43
12070 },
12071 "name": "toJson",
12072 "overrides": "@aws-cdk/aws-cloudwatch.ConcreteWidget",
12073 "returns": {
12074 "type": {
12075 "collection": {
12076 "elementtype": {
12077 "primitive": "any"
12078 },
12079 "kind": "array"
12080 }
12081 }
12082 }
12083 }
12084 ],
12085 "name": "TextWidget",
12086 "symbolId": "lib/text:TextWidget"
12087 },
12088 "@aws-cdk/aws-cloudwatch.TextWidgetProps": {
12089 "assembly": "@aws-cdk/aws-cloudwatch",
12090 "datatype": true,
12091 "docs": {
12092 "custom": {
12093 "exampleMetadata": "infused"
12094 },
12095 "example": "declare const dashboard: cloudwatch.Dashboard;\n\ndashboard.addWidgets(new cloudwatch.TextWidget({\n markdown: '# Key Performance Indicators'\n}));",
12096 "stability": "stable",
12097 "summary": "Properties for a Text widget."
12098 },
12099 "fqn": "@aws-cdk/aws-cloudwatch.TextWidgetProps",
12100 "kind": "interface",
12101 "locationInModule": {
12102 "filename": "lib/text.ts",
12103 "line": 6
12104 },
12105 "name": "TextWidgetProps",
12106 "properties": [
12107 {
12108 "abstract": true,
12109 "docs": {
12110 "stability": "stable",
12111 "summary": "The text to display, in MarkDown format."
12112 },
12113 "immutable": true,
12114 "locationInModule": {
12115 "filename": "lib/text.ts",
12116 "line": 10
12117 },
12118 "name": "markdown",
12119 "type": {
12120 "primitive": "string"
12121 }
12122 },
12123 {
12124 "abstract": true,
12125 "docs": {
12126 "default": "2",
12127 "stability": "stable",
12128 "summary": "Height of the widget."
12129 },
12130 "immutable": true,
12131 "locationInModule": {
12132 "filename": "lib/text.ts",
12133 "line": 24
12134 },
12135 "name": "height",
12136 "optional": true,
12137 "type": {
12138 "primitive": "number"
12139 }
12140 },
12141 {
12142 "abstract": true,
12143 "docs": {
12144 "default": "6",
12145 "stability": "stable",
12146 "summary": "Width of the widget, in a grid of 24 units wide."
12147 },
12148 "immutable": true,
12149 "locationInModule": {
12150 "filename": "lib/text.ts",
12151 "line": 17
12152 },
12153 "name": "width",
12154 "optional": true,
12155 "type": {
12156 "primitive": "number"
12157 }
12158 }
12159 ],
12160 "symbolId": "lib/text:TextWidgetProps"
12161 },
12162 "@aws-cdk/aws-cloudwatch.TreatMissingData": {
12163 "assembly": "@aws-cdk/aws-cloudwatch",
12164 "docs": {
12165 "custom": {
12166 "exampleMetadata": "infused"
12167 },
12168 "example": "import * as cdk from '@aws-cdk/core';\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\n\nconst fn = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_16_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n timeout: cdk.Duration.minutes(5),\n});\n\nif (fn.timeout) {\n new cloudwatch.Alarm(this, `MyAlarm`, {\n metric: fn.metricDuration().with({\n statistic: 'Maximum',\n }),\n evaluationPeriods: 1,\n datapointsToAlarm: 1,\n threshold: fn.timeout.toMilliseconds(),\n treatMissingData: cloudwatch.TreatMissingData.IGNORE,\n alarmName: 'My Lambda Timeout',\n });\n}",
12169 "stability": "stable",
12170 "summary": "Specify how missing data points are treated during alarm evaluation."
12171 },
12172 "fqn": "@aws-cdk/aws-cloudwatch.TreatMissingData",
12173 "kind": "enum",
12174 "locationInModule": {
12175 "filename": "lib/alarm.ts",
12176 "line": 80
12177 },
12178 "members": [
12179 {
12180 "docs": {
12181 "stability": "stable",
12182 "summary": "Missing data points are treated as breaching the threshold."
12183 },
12184 "name": "BREACHING"
12185 },
12186 {
12187 "docs": {
12188 "stability": "stable",
12189 "summary": "Missing data points are treated as being within the threshold."
12190 },
12191 "name": "NOT_BREACHING"
12192 },
12193 {
12194 "docs": {
12195 "stability": "stable",
12196 "summary": "The current alarm state is maintained."
12197 },
12198 "name": "IGNORE"
12199 },
12200 {
12201 "docs": {
12202 "stability": "stable",
12203 "summary": "The alarm does not consider missing data points when evaluating whether to change state."
12204 },
12205 "name": "MISSING"
12206 }
12207 ],
12208 "name": "TreatMissingData",
12209 "symbolId": "lib/alarm:TreatMissingData"
12210 },
12211 "@aws-cdk/aws-cloudwatch.Unit": {
12212 "assembly": "@aws-cdk/aws-cloudwatch",
12213 "docs": {
12214 "stability": "stable",
12215 "summary": "Unit for metric."
12216 },
12217 "fqn": "@aws-cdk/aws-cloudwatch.Unit",
12218 "kind": "enum",
12219 "locationInModule": {
12220 "filename": "lib/metric-types.ts",
12221 "line": 87
12222 },
12223 "members": [
12224 {
12225 "docs": {
12226 "stability": "stable",
12227 "summary": "Seconds."
12228 },
12229 "name": "SECONDS"
12230 },
12231 {
12232 "docs": {
12233 "stability": "stable",
12234 "summary": "Microseconds."
12235 },
12236 "name": "MICROSECONDS"
12237 },
12238 {
12239 "docs": {
12240 "stability": "stable",
12241 "summary": "Milliseconds."
12242 },
12243 "name": "MILLISECONDS"
12244 },
12245 {
12246 "docs": {
12247 "stability": "stable",
12248 "summary": "Bytes."
12249 },
12250 "name": "BYTES"
12251 },
12252 {
12253 "docs": {
12254 "stability": "stable",
12255 "summary": "Kilobytes."
12256 },
12257 "name": "KILOBYTES"
12258 },
12259 {
12260 "docs": {
12261 "stability": "stable",
12262 "summary": "Megabytes."
12263 },
12264 "name": "MEGABYTES"
12265 },
12266 {
12267 "docs": {
12268 "stability": "stable",
12269 "summary": "Gigabytes."
12270 },
12271 "name": "GIGABYTES"
12272 },
12273 {
12274 "docs": {
12275 "stability": "stable",
12276 "summary": "Terabytes."
12277 },
12278 "name": "TERABYTES"
12279 },
12280 {
12281 "docs": {
12282 "stability": "stable",
12283 "summary": "Bits."
12284 },
12285 "name": "BITS"
12286 },
12287 {
12288 "docs": {
12289 "stability": "stable",
12290 "summary": "Kilobits."
12291 },
12292 "name": "KILOBITS"
12293 },
12294 {
12295 "docs": {
12296 "stability": "stable",
12297 "summary": "Megabits."
12298 },
12299 "name": "MEGABITS"
12300 },
12301 {
12302 "docs": {
12303 "stability": "stable",
12304 "summary": "Gigabits."
12305 },
12306 "name": "GIGABITS"
12307 },
12308 {
12309 "docs": {
12310 "stability": "stable",
12311 "summary": "Terabits."
12312 },
12313 "name": "TERABITS"
12314 },
12315 {
12316 "docs": {
12317 "stability": "stable",
12318 "summary": "Percent."
12319 },
12320 "name": "PERCENT"
12321 },
12322 {
12323 "docs": {
12324 "stability": "stable",
12325 "summary": "Count."
12326 },
12327 "name": "COUNT"
12328 },
12329 {
12330 "docs": {
12331 "stability": "stable",
12332 "summary": "Bytes/second (B/s)."
12333 },
12334 "name": "BYTES_PER_SECOND"
12335 },
12336 {
12337 "docs": {
12338 "stability": "stable",
12339 "summary": "Kilobytes/second (kB/s)."
12340 },
12341 "name": "KILOBYTES_PER_SECOND"
12342 },
12343 {
12344 "docs": {
12345 "stability": "stable",
12346 "summary": "Megabytes/second (MB/s)."
12347 },
12348 "name": "MEGABYTES_PER_SECOND"
12349 },
12350 {
12351 "docs": {
12352 "stability": "stable",
12353 "summary": "Gigabytes/second (GB/s)."
12354 },
12355 "name": "GIGABYTES_PER_SECOND"
12356 },
12357 {
12358 "docs": {
12359 "stability": "stable",
12360 "summary": "Terabytes/second (TB/s)."
12361 },
12362 "name": "TERABYTES_PER_SECOND"
12363 },
12364 {
12365 "docs": {
12366 "stability": "stable",
12367 "summary": "Bits/second (b/s)."
12368 },
12369 "name": "BITS_PER_SECOND"
12370 },
12371 {
12372 "docs": {
12373 "stability": "stable",
12374 "summary": "Kilobits/second (kb/s)."
12375 },
12376 "name": "KILOBITS_PER_SECOND"
12377 },
12378 {
12379 "docs": {
12380 "stability": "stable",
12381 "summary": "Megabits/second (Mb/s)."
12382 },
12383 "name": "MEGABITS_PER_SECOND"
12384 },
12385 {
12386 "docs": {
12387 "stability": "stable",
12388 "summary": "Gigabits/second (Gb/s)."
12389 },
12390 "name": "GIGABITS_PER_SECOND"
12391 },
12392 {
12393 "docs": {
12394 "stability": "stable",
12395 "summary": "Terabits/second (Tb/s)."
12396 },
12397 "name": "TERABITS_PER_SECOND"
12398 },
12399 {
12400 "docs": {
12401 "stability": "stable",
12402 "summary": "Count/second."
12403 },
12404 "name": "COUNT_PER_SECOND"
12405 },
12406 {
12407 "docs": {
12408 "stability": "stable",
12409 "summary": "None."
12410 },
12411 "name": "NONE"
12412 }
12413 ],
12414 "name": "Unit",
12415 "symbolId": "lib/metric-types:Unit"
12416 },
12417 "@aws-cdk/aws-cloudwatch.YAxisProps": {
12418 "assembly": "@aws-cdk/aws-cloudwatch",
12419 "datatype": true,
12420 "docs": {
12421 "stability": "stable",
12422 "summary": "Properties for a Y-Axis.",
12423 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\nconst yAxisProps: cloudwatch.YAxisProps = {\n label: 'label',\n max: 123,\n min: 123,\n showUnits: false,\n};",
12424 "custom": {
12425 "exampleMetadata": "fixture=_generated"
12426 }
12427 },
12428 "fqn": "@aws-cdk/aws-cloudwatch.YAxisProps",
12429 "kind": "interface",
12430 "locationInModule": {
12431 "filename": "lib/graph.ts",
12432 "line": 44
12433 },
12434 "name": "YAxisProps",
12435 "properties": [
12436 {
12437 "abstract": true,
12438 "docs": {
12439 "default": "- No label",
12440 "stability": "stable",
12441 "summary": "The label."
12442 },
12443 "immutable": true,
12444 "locationInModule": {
12445 "filename": "lib/graph.ts",
12446 "line": 64
12447 },
12448 "name": "label",
12449 "optional": true,
12450 "type": {
12451 "primitive": "string"
12452 }
12453 },
12454 {
12455 "abstract": true,
12456 "docs": {
12457 "default": "- No maximum value",
12458 "stability": "stable",
12459 "summary": "The max value."
12460 },
12461 "immutable": true,
12462 "locationInModule": {
12463 "filename": "lib/graph.ts",
12464 "line": 57
12465 },
12466 "name": "max",
12467 "optional": true,
12468 "type": {
12469 "primitive": "number"
12470 }
12471 },
12472 {
12473 "abstract": true,
12474 "docs": {
12475 "default": "0",
12476 "stability": "stable",
12477 "summary": "The min value."
12478 },
12479 "immutable": true,
12480 "locationInModule": {
12481 "filename": "lib/graph.ts",
12482 "line": 50
12483 },
12484 "name": "min",
12485 "optional": true,
12486 "type": {
12487 "primitive": "number"
12488 }
12489 },
12490 {
12491 "abstract": true,
12492 "docs": {
12493 "default": "true",
12494 "stability": "stable",
12495 "summary": "Whether to show units."
12496 },
12497 "immutable": true,
12498 "locationInModule": {
12499 "filename": "lib/graph.ts",
12500 "line": 71
12501 },
12502 "name": "showUnits",
12503 "optional": true,
12504 "type": {
12505 "primitive": "boolean"
12506 }
12507 }
12508 ],
12509 "symbolId": "lib/graph:YAxisProps"
12510 }
12511 },
12512 "version": "1.161.0",
12513 "fingerprint": "**********"
12514}