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-cloudwatch": "1.198.0",
|
12 | "@aws-cdk/aws-iam": "1.198.0",
|
13 | "@aws-cdk/aws-kms": "1.198.0",
|
14 | "@aws-cdk/aws-s3-assets": "1.198.0",
|
15 | "@aws-cdk/core": "1.198.0",
|
16 | "@aws-cdk/cx-api": "1.198.0",
|
17 | "constructs": "^3.3.69"
|
18 | },
|
19 | "dependencyClosure": {
|
20 | "@aws-cdk/assets": {
|
21 | "targets": {
|
22 | "dotnet": {
|
23 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
24 | "namespace": "Amazon.CDK.Assets",
|
25 | "packageId": "Amazon.CDK.Assets"
|
26 | },
|
27 | "java": {
|
28 | "maven": {
|
29 | "artifactId": "cdk-assets",
|
30 | "groupId": "software.amazon.awscdk"
|
31 | },
|
32 | "package": "software.amazon.awscdk.assets"
|
33 | },
|
34 | "js": {
|
35 | "npm": "@aws-cdk/assets"
|
36 | },
|
37 | "python": {
|
38 | "classifiers": [
|
39 | "Framework :: AWS CDK",
|
40 | "Framework :: AWS CDK :: 1"
|
41 | ],
|
42 | "distName": "aws-cdk.assets",
|
43 | "module": "aws_cdk.assets"
|
44 | }
|
45 | }
|
46 | },
|
47 | "@aws-cdk/aws-cloudwatch": {
|
48 | "targets": {
|
49 | "dotnet": {
|
50 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
51 | "namespace": "Amazon.CDK.AWS.CloudWatch",
|
52 | "packageId": "Amazon.CDK.AWS.CloudWatch"
|
53 | },
|
54 | "java": {
|
55 | "maven": {
|
56 | "artifactId": "cloudwatch",
|
57 | "groupId": "software.amazon.awscdk"
|
58 | },
|
59 | "package": "software.amazon.awscdk.services.cloudwatch"
|
60 | },
|
61 | "js": {
|
62 | "npm": "@aws-cdk/aws-cloudwatch"
|
63 | },
|
64 | "python": {
|
65 | "classifiers": [
|
66 | "Framework :: AWS CDK",
|
67 | "Framework :: AWS CDK :: 1"
|
68 | ],
|
69 | "distName": "aws-cdk.aws-cloudwatch",
|
70 | "module": "aws_cdk.aws_cloudwatch"
|
71 | }
|
72 | }
|
73 | },
|
74 | "@aws-cdk/aws-events": {
|
75 | "targets": {
|
76 | "dotnet": {
|
77 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
78 | "namespace": "Amazon.CDK.AWS.Events",
|
79 | "packageId": "Amazon.CDK.AWS.Events"
|
80 | },
|
81 | "java": {
|
82 | "maven": {
|
83 | "artifactId": "events",
|
84 | "groupId": "software.amazon.awscdk"
|
85 | },
|
86 | "package": "software.amazon.awscdk.services.events"
|
87 | },
|
88 | "js": {
|
89 | "npm": "@aws-cdk/aws-events"
|
90 | },
|
91 | "python": {
|
92 | "classifiers": [
|
93 | "Framework :: AWS CDK",
|
94 | "Framework :: AWS CDK :: 1"
|
95 | ],
|
96 | "distName": "aws-cdk.aws-events",
|
97 | "module": "aws_cdk.aws_events"
|
98 | }
|
99 | }
|
100 | },
|
101 | "@aws-cdk/aws-iam": {
|
102 | "targets": {
|
103 | "dotnet": {
|
104 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
105 | "namespace": "Amazon.CDK.AWS.IAM",
|
106 | "packageId": "Amazon.CDK.AWS.IAM"
|
107 | },
|
108 | "java": {
|
109 | "maven": {
|
110 | "artifactId": "iam",
|
111 | "groupId": "software.amazon.awscdk"
|
112 | },
|
113 | "package": "software.amazon.awscdk.services.iam"
|
114 | },
|
115 | "js": {
|
116 | "npm": "@aws-cdk/aws-iam"
|
117 | },
|
118 | "python": {
|
119 | "classifiers": [
|
120 | "Framework :: AWS CDK",
|
121 | "Framework :: AWS CDK :: 1"
|
122 | ],
|
123 | "distName": "aws-cdk.aws-iam",
|
124 | "module": "aws_cdk.aws_iam"
|
125 | }
|
126 | }
|
127 | },
|
128 | "@aws-cdk/aws-kms": {
|
129 | "targets": {
|
130 | "dotnet": {
|
131 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
132 | "namespace": "Amazon.CDK.AWS.KMS",
|
133 | "packageId": "Amazon.CDK.AWS.KMS"
|
134 | },
|
135 | "java": {
|
136 | "maven": {
|
137 | "artifactId": "kms",
|
138 | "groupId": "software.amazon.awscdk"
|
139 | },
|
140 | "package": "software.amazon.awscdk.services.kms"
|
141 | },
|
142 | "js": {
|
143 | "npm": "@aws-cdk/aws-kms"
|
144 | },
|
145 | "python": {
|
146 | "classifiers": [
|
147 | "Framework :: AWS CDK",
|
148 | "Framework :: AWS CDK :: 1"
|
149 | ],
|
150 | "distName": "aws-cdk.aws-kms",
|
151 | "module": "aws_cdk.aws_kms"
|
152 | }
|
153 | }
|
154 | },
|
155 | "@aws-cdk/aws-s3": {
|
156 | "targets": {
|
157 | "dotnet": {
|
158 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
159 | "namespace": "Amazon.CDK.AWS.S3",
|
160 | "packageId": "Amazon.CDK.AWS.S3"
|
161 | },
|
162 | "java": {
|
163 | "maven": {
|
164 | "artifactId": "s3",
|
165 | "groupId": "software.amazon.awscdk"
|
166 | },
|
167 | "package": "software.amazon.awscdk.services.s3"
|
168 | },
|
169 | "js": {
|
170 | "npm": "@aws-cdk/aws-s3"
|
171 | },
|
172 | "python": {
|
173 | "classifiers": [
|
174 | "Framework :: AWS CDK",
|
175 | "Framework :: AWS CDK :: 1"
|
176 | ],
|
177 | "distName": "aws-cdk.aws-s3",
|
178 | "module": "aws_cdk.aws_s3"
|
179 | }
|
180 | }
|
181 | },
|
182 | "@aws-cdk/aws-s3-assets": {
|
183 | "targets": {
|
184 | "dotnet": {
|
185 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
186 | "namespace": "Amazon.CDK.AWS.S3.Assets",
|
187 | "packageId": "Amazon.CDK.AWS.S3.Assets"
|
188 | },
|
189 | "java": {
|
190 | "maven": {
|
191 | "artifactId": "s3-assets",
|
192 | "groupId": "software.amazon.awscdk"
|
193 | },
|
194 | "package": "software.amazon.awscdk.services.s3.assets"
|
195 | },
|
196 | "js": {
|
197 | "npm": "@aws-cdk/aws-s3-assets"
|
198 | },
|
199 | "python": {
|
200 | "classifiers": [
|
201 | "Framework :: AWS CDK",
|
202 | "Framework :: AWS CDK :: 1"
|
203 | ],
|
204 | "distName": "aws-cdk.aws-s3-assets",
|
205 | "module": "aws_cdk.aws_s3_assets"
|
206 | }
|
207 | }
|
208 | },
|
209 | "@aws-cdk/cloud-assembly-schema": {
|
210 | "targets": {
|
211 | "dotnet": {
|
212 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
213 | "namespace": "Amazon.CDK.CloudAssembly.Schema",
|
214 | "packageId": "Amazon.CDK.CloudAssembly.Schema"
|
215 | },
|
216 | "java": {
|
217 | "maven": {
|
218 | "artifactId": "cdk-cloud-assembly-schema",
|
219 | "groupId": "software.amazon.awscdk"
|
220 | },
|
221 | "package": "software.amazon.awscdk.cloudassembly.schema"
|
222 | },
|
223 | "js": {
|
224 | "npm": "@aws-cdk/cloud-assembly-schema"
|
225 | },
|
226 | "python": {
|
227 | "classifiers": [
|
228 | "Framework :: AWS CDK",
|
229 | "Framework :: AWS CDK :: 1"
|
230 | ],
|
231 | "distName": "aws-cdk.cloud-assembly-schema",
|
232 | "module": "aws_cdk.cloud_assembly_schema"
|
233 | }
|
234 | }
|
235 | },
|
236 | "@aws-cdk/core": {
|
237 | "targets": {
|
238 | "dotnet": {
|
239 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
240 | "namespace": "Amazon.CDK",
|
241 | "packageId": "Amazon.CDK"
|
242 | },
|
243 | "java": {
|
244 | "maven": {
|
245 | "artifactId": "core",
|
246 | "groupId": "software.amazon.awscdk"
|
247 | },
|
248 | "package": "software.amazon.awscdk.core"
|
249 | },
|
250 | "js": {
|
251 | "npm": "@aws-cdk/core"
|
252 | },
|
253 | "python": {
|
254 | "classifiers": [
|
255 | "Framework :: AWS CDK",
|
256 | "Framework :: AWS CDK :: 1"
|
257 | ],
|
258 | "distName": "aws-cdk.core",
|
259 | "module": "aws_cdk.core"
|
260 | }
|
261 | }
|
262 | },
|
263 | "@aws-cdk/cx-api": {
|
264 | "targets": {
|
265 | "dotnet": {
|
266 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
267 | "namespace": "Amazon.CDK.CXAPI",
|
268 | "packageId": "Amazon.CDK.CXAPI"
|
269 | },
|
270 | "java": {
|
271 | "maven": {
|
272 | "artifactId": "cdk-cx-api",
|
273 | "groupId": "software.amazon.awscdk"
|
274 | },
|
275 | "package": "software.amazon.awscdk.cxapi"
|
276 | },
|
277 | "js": {
|
278 | "npm": "@aws-cdk/cx-api"
|
279 | },
|
280 | "python": {
|
281 | "classifiers": [
|
282 | "Framework :: AWS CDK",
|
283 | "Framework :: AWS CDK :: 1"
|
284 | ],
|
285 | "distName": "aws-cdk.cx-api",
|
286 | "module": "aws_cdk.cx_api"
|
287 | }
|
288 | }
|
289 | },
|
290 | "@aws-cdk/region-info": {
|
291 | "targets": {
|
292 | "dotnet": {
|
293 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
294 | "namespace": "Amazon.CDK.RegionInfo",
|
295 | "packageId": "Amazon.CDK.RegionInfo"
|
296 | },
|
297 | "java": {
|
298 | "maven": {
|
299 | "artifactId": "cdk-region-info",
|
300 | "groupId": "software.amazon.awscdk"
|
301 | },
|
302 | "package": "software.amazon.awscdk.regioninfo"
|
303 | },
|
304 | "js": {
|
305 | "npm": "@aws-cdk/region-info"
|
306 | },
|
307 | "python": {
|
308 | "classifiers": [
|
309 | "Framework :: AWS CDK",
|
310 | "Framework :: AWS CDK :: 1"
|
311 | ],
|
312 | "distName": "aws-cdk.region-info",
|
313 | "module": "aws_cdk.region_info"
|
314 | }
|
315 | }
|
316 | },
|
317 | "constructs": {
|
318 | "targets": {
|
319 | "dotnet": {
|
320 | "namespace": "Constructs",
|
321 | "packageId": "Constructs"
|
322 | },
|
323 | "go": {
|
324 | "moduleName": "github.com/aws/constructs-go"
|
325 | },
|
326 | "java": {
|
327 | "maven": {
|
328 | "artifactId": "constructs",
|
329 | "groupId": "software.constructs"
|
330 | },
|
331 | "package": "software.constructs"
|
332 | },
|
333 | "js": {
|
334 | "npm": "constructs"
|
335 | },
|
336 | "python": {
|
337 | "distName": "constructs",
|
338 | "module": "constructs"
|
339 | }
|
340 | }
|
341 | }
|
342 | },
|
343 | "description": "The CDK Construct Library for AWS::Logs",
|
344 | "docs": {
|
345 | "stability": "stable"
|
346 | },
|
347 | "homepage": "https://github.com/aws/aws-cdk",
|
348 | "jsiiVersion": "1.74.0 (build 6d08790)",
|
349 | "keywords": [
|
350 | "aws",
|
351 | "cdk",
|
352 | "constructs",
|
353 | "logs"
|
354 | ],
|
355 | "license": "Apache-2.0",
|
356 | "metadata": {
|
357 | "jsii": {
|
358 | "compiledWithDeprecationWarnings": true,
|
359 | "pacmak": {
|
360 | "hasDefaultInterfaces": true
|
361 | },
|
362 | "rosetta": {
|
363 | "strict": true
|
364 | }
|
365 | }
|
366 | },
|
367 | "name": "@aws-cdk/aws-logs",
|
368 | "readme": {
|
369 | "markdown": "# Amazon CloudWatch Logs 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\nThis library supplies constructs for working with CloudWatch Logs.\n\n## Log Groups/Streams\n\nThe basic unit of CloudWatch is a *Log Group*. Every log group typically has the\nsame kind of data logged to it, in the same format. If there are multiple\napplications or services logging into the Log Group, each of them creates a new\n*Log Stream*.\n\nEvery log operation creates a \"log event\", which can consist of a simple string\nor a single-line JSON object. JSON objects have the advantage that they afford\nmore filtering abilities (see below).\n\nThe only configurable attribute for log streams is the retention period, which\nconfigures after how much time the events in the log stream expire and are\ndeleted.\n\nThe default retention period if not supplied is 2 years, but it can be set to\none of the values in the `RetentionDays` enum to configure a different\nretention period (including infinite retention).\n\n```ts lit=test/example.retention.lit.ts\n// Configure log group for short retention\nconst logGroup = new LogGroup(stack, 'LogGroup', {\n retention: RetentionDays.ONE_WEEK,\n});\n// Configure log group for infinite retention\nconst logGroup = new LogGroup(stack, 'LogGroup', {\n retention: Infinity,\n});\n```\n\n## LogRetention\n\nThe `LogRetention` construct is a way to control the retention period of log groups that are created outside of the CDK. The construct is usually\nused on log groups that are auto created by AWS services, such as [AWS\nlambda](https://docs.aws.amazon.com/lambda/latest/dg/monitoring-cloudwatchlogs.html).\n\nThis is implemented using a [CloudFormation custom\nresource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html)\nwhich pre-creates the log group if it doesn't exist, and sets the specified log retention period (never expire, by default).\n\nBy default, the log group will be created in the same region as the stack. The `logGroupRegion` property can be used to configure\nlog groups in other regions. This is typically useful when controlling retention for log groups auto-created by global services that\npublish their log group to a specific region, such as AWS Chatbot creating a log group in `us-east-1`.\n\n## Resource Policy\n\nCloudWatch Resource Policies allow other AWS services or IAM Principals to put log events into the log groups.\nA resource policy is automatically created when `addToResourcePolicy` is called on the LogGroup for the first time:\n\n```ts\nconst logGroup = new logs.LogGroup(this, 'LogGroup');\nlogGroup.addToResourcePolicy(new iam.PolicyStatement({\n actions: ['logs:CreateLogStream', 'logs:PutLogEvents'],\n principals: [new iam.ServicePrincipal('es.amazonaws.com')],\n resources: [logGroup.logGroupArn],\n}));\n```\n\nOr more conveniently, write permissions to the log group can be granted as follows which gives same result as in the above example.\n\n```ts\nconst logGroup = new logs.LogGroup(this, 'LogGroup');\nlogGroup.grantWrite(new iam.ServicePrincipal('es.amazonaws.com'));\n```\n\nBe aware that any ARNs or tokenized values passed to the resource policy will be converted into AWS Account IDs.\nThis is because CloudWatch Logs Resource Policies do not accept ARNs as principals, but they do accept\nAccount ID strings. Non-ARN principals, like Service principals or Any princpals, are accepted by CloudWatch.\n\n## Encrypting Log Groups\n\nBy default, log group data is always encrypted in CloudWatch Logs. You have the\noption to encrypt log group data using a AWS KMS customer master key (CMK) should\nyou not wish to use the default AWS encryption. Keep in mind that if you decide to\nencrypt a log group, any service or IAM identity that needs to read the encrypted\nlog streams in the future will require the same CMK to decrypt the data.\n\nHere's a simple example of creating an encrypted Log Group using a KMS CMK.\n\n```ts\nimport * as kms from '@aws-cdk/aws-kms';\n\nnew logs.LogGroup(this, 'LogGroup', {\n encryptionKey: new kms.Key(this, 'Key'),\n});\n```\n\nSee the AWS documentation for more detailed information about [encrypting CloudWatch\nLogs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html).\n\n## Subscriptions and Destinations\n\nLog events matching a particular filter can be sent to either a Lambda function\nor a Kinesis stream.\n\nIf the Kinesis stream lives in a different account, a `CrossAccountDestination`\nobject needs to be added in the destination account which will act as a proxy\nfor the remote Kinesis stream. This object is automatically created for you\nif you use the CDK Kinesis library.\n\nCreate a `SubscriptionFilter`, initialize it with an appropriate `Pattern` (see\nbelow) and supply the intended destination:\n\n```ts\nimport * as destinations from '@aws-cdk/aws-logs-destinations';\ndeclare const fn: lambda.Function;\ndeclare const logGroup: logs.LogGroup;\n\nnew logs.SubscriptionFilter(this, 'Subscription', {\n logGroup,\n destination: new destinations.LambdaDestination(fn),\n filterPattern: logs.FilterPattern.allTerms(\"ERROR\", \"MainThread\"),\n});\n```\n\n## Metric Filters\n\nCloudWatch Logs can extract and emit metrics based on a textual log stream.\nDepending on your needs, this may be a more convenient way of generating metrics\nfor you application than making calls to CloudWatch Metrics yourself.\n\nA `MetricFilter` either emits a fixed number every time it sees a log event\nmatching a particular pattern (see below), or extracts a number from the log\nevent and uses that as the metric value.\n\nExample:\n\n```ts lit=test/integ.metricfilter.lit.ts\nnew MetricFilter(this, 'MetricFilter', {\n logGroup,\n metricNamespace: 'MyApp',\n metricName: 'Latency',\n filterPattern: FilterPattern.exists('$.latency'),\n metricValue: '$.latency',\n});\n```\n\nRemember that if you want to use a value from the log event as the metric value,\nyou must mention it in your pattern somewhere.\n\nA very simple MetricFilter can be created by using the `logGroup.extractMetric()`\nhelper function:\n\n```ts\ndeclare const logGroup: logs.LogGroup;\nlogGroup.extractMetric('$.jsonField', 'Namespace', 'MetricName');\n```\n\nWill extract the value of `jsonField` wherever it occurs in JSON-structed\nlog records in the LogGroup, and emit them to CloudWatch Metrics under\nthe name `Namespace/MetricName`.\n\n### Exposing Metric on a Metric Filter\n\nYou can expose a metric on a metric filter by calling the `MetricFilter.metric()` API.\nThis has a default of `statistic = 'avg'` if the statistic is not set in the `props`.\n\n```ts\ndeclare const logGroup: logs.LogGroup;\nconst mf = new logs.MetricFilter(this, 'MetricFilter', {\n logGroup,\n metricNamespace: 'MyApp',\n metricName: 'Latency',\n filterPattern: logs.FilterPattern.exists('$.latency'),\n metricValue: '$.latency',\n});\n\n//expose a metric from the metric filter\nconst metric = mf.metric();\n\n//you can use the metric to create a new alarm\nnew cloudwatch.Alarm(this, 'alarm from metric filter', {\n metric,\n threshold: 100,\n evaluationPeriods: 2,\n});\n```\n\n## Patterns\n\nPatterns describe which log events match a subscription or metric filter. There\nare three types of patterns:\n\n* Text patterns\n* JSON patterns\n* Space-delimited table patterns\n\nAll patterns are constructed by using static functions on the `FilterPattern`\nclass.\n\nIn addition to the patterns above, the following special patterns exist:\n\n* `FilterPattern.allEvents()`: matches all log events.\n* `FilterPattern.literal(string)`: if you already know what pattern expression to\n use, this function takes a string and will use that as the log pattern. For\n more information, see the [Filter and Pattern\n Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).\n\n### Text Patterns\n\nText patterns match if the literal strings appear in the text form of the log\nline.\n\n* `FilterPattern.allTerms(term, term, ...)`: matches if all of the given terms\n (substrings) appear in the log event.\n* `FilterPattern.anyTerm(term, term, ...)`: matches if all of the given terms\n (substrings) appear in the log event.\n* `FilterPattern.anyTermGroup([term, term, ...], [term, term, ...], ...)`: matches if\n all of the terms in any of the groups (specified as arrays) matches. This is\n an OR match.\n\nExamples:\n\n```ts\n// Search for lines that contain both \"ERROR\" and \"MainThread\"\nconst pattern1 = logs.FilterPattern.allTerms('ERROR', 'MainThread');\n\n// Search for lines that either contain both \"ERROR\" and \"MainThread\", or\n// both \"WARN\" and \"Deadlock\".\nconst pattern2 = logs.FilterPattern.anyTermGroup(\n ['ERROR', 'MainThread'],\n ['WARN', 'Deadlock'],\n);\n```\n\n## JSON Patterns\n\nJSON patterns apply if the log event is the JSON representation of an object\n(without any other characters, so it cannot include a prefix such as timestamp\nor log level). JSON patterns can make comparisons on the values inside the\nfields.\n\n* **Strings**: the comparison operators allowed for strings are `=` and `!=`.\n String values can start or end with a `*` wildcard.\n* **Numbers**: the comparison operators allowed for numbers are `=`, `!=`,\n `<`, `<=`, `>`, `>=`.\n\nFields in the JSON structure are identified by identifier the complete object as `$`\nand then descending into it, such as `$.field` or `$.list[0].field`.\n\n* `FilterPattern.stringValue(field, comparison, string)`: matches if the given\n field compares as indicated with the given string value.\n* `FilterPattern.numberValue(field, comparison, number)`: matches if the given\n field compares as indicated with the given numerical value.\n* `FilterPattern.isNull(field)`: matches if the given field exists and has the\n value `null`.\n* `FilterPattern.notExists(field)`: matches if the given field is not in the JSON\n structure.\n* `FilterPattern.exists(field)`: matches if the given field is in the JSON\n structure.\n* `FilterPattern.booleanValue(field, boolean)`: matches if the given field\n is exactly the given boolean value.\n* `FilterPattern.all(jsonPattern, jsonPattern, ...)`: matches if all of the\n given JSON patterns match. This makes an AND combination of the given\n patterns.\n* `FilterPattern.any(jsonPattern, jsonPattern, ...)`: matches if any of the\n given JSON patterns match. This makes an OR combination of the given\n patterns.\n\nExample:\n\n```ts\n// Search for all events where the component field is equal to\n// \"HttpServer\" and either error is true or the latency is higher\n// than 1000.\nconst pattern = logs.FilterPattern.all(\n logs.FilterPattern.stringValue('$.component', '=', 'HttpServer'),\n logs.FilterPattern.any(\n logs.FilterPattern.booleanValue('$.error', true),\n logs.FilterPattern.numberValue('$.latency', '>', 1000),\n ),\n);\n```\n\n## Space-delimited table patterns\n\nIf the log events are rows of a space-delimited table, this pattern can be used\nto identify the columns in that structure and add conditions on any of them. The\ncanonical example where you would apply this type of pattern is Apache server\nlogs.\n\nText that is surrounded by `\"...\"` quotes or `[...]` square brackets will\nbe treated as one column.\n\n* `FilterPattern.spaceDelimited(column, column, ...)`: construct a\n `SpaceDelimitedTextPattern` object with the indicated columns. The columns\n map one-by-one the columns found in the log event. The string `\"...\"` may\n be used to specify an arbitrary number of unnamed columns anywhere in the\n name list (but may only be specified once).\n\nAfter constructing a `SpaceDelimitedTextPattern`, you can use the following\ntwo members to add restrictions:\n\n* `pattern.whereString(field, comparison, string)`: add a string condition.\n The rules are the same as for JSON patterns.\n* `pattern.whereNumber(field, comparison, number)`: add a numerical condition.\n The rules are the same as for JSON patterns.\n\nMultiple restrictions can be added on the same column; they must all apply.\n\nExample:\n\n```ts\n// Search for all events where the component is \"HttpServer\" and the\n// result code is not equal to 200.\nconst pattern = logs.FilterPattern.spaceDelimited('time', 'component', '...', 'result_code', 'latency')\n .whereString('component', '=', 'HttpServer')\n .whereNumber('result_code', '!=', 200);\n```\n\n## Logs Insights Query Definition\n\nCreates a query definition for CloudWatch Logs Insights.\n\nExample:\n\n```ts\nnew logs.QueryDefinition(this, 'QueryDefinition', {\n queryDefinitionName: 'MyQuery',\n queryString: new logs.QueryString({\n fields: ['@timestamp', '@message'],\n sort: '@timestamp desc',\n limit: 20,\n }),\n});\n```\n\n## Notes\n\nBe aware that Log Group ARNs will always have the string `:*` appended to\nthem, to match the behavior of [the CloudFormation `AWS::Logs::LogGroup`\nresource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#aws-resource-logs-loggroup-return-values).\n"
|
370 | },
|
371 | "repository": {
|
372 | "directory": "packages/@aws-cdk/aws-logs",
|
373 | "type": "git",
|
374 | "url": "https://github.com/aws/aws-cdk.git"
|
375 | },
|
376 | "schema": "jsii/0.10.0",
|
377 | "targets": {
|
378 | "dotnet": {
|
379 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
380 | "namespace": "Amazon.CDK.AWS.Logs",
|
381 | "packageId": "Amazon.CDK.AWS.Logs"
|
382 | },
|
383 | "java": {
|
384 | "maven": {
|
385 | "artifactId": "logs",
|
386 | "groupId": "software.amazon.awscdk"
|
387 | },
|
388 | "package": "software.amazon.awscdk.services.logs"
|
389 | },
|
390 | "js": {
|
391 | "npm": "@aws-cdk/aws-logs"
|
392 | },
|
393 | "python": {
|
394 | "classifiers": [
|
395 | "Framework :: AWS CDK",
|
396 | "Framework :: AWS CDK :: 1"
|
397 | ],
|
398 | "distName": "aws-cdk.aws-logs",
|
399 | "module": "aws_cdk.aws_logs"
|
400 | }
|
401 | },
|
402 | "types": {
|
403 | "@aws-cdk/aws-logs.CfnDestination": {
|
404 | "assembly": "@aws-cdk/aws-logs",
|
405 | "base": "@aws-cdk/core.CfnResource",
|
406 | "docs": {
|
407 | "custom": {
|
408 | "cloudformationResource": "AWS::Logs::Destination",
|
409 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html",
|
410 | "exampleMetadata": "fixture=_generated"
|
411 | },
|
412 | "remarks": "The AWS::Logs::Destination resource specifies a CloudWatch Logs destination. A destination encapsulates a physical resource (such as an Amazon Kinesis data stream) and enables you to subscribe that resource to a stream of log events.",
|
413 | "stability": "external",
|
414 | "summary": "A CloudFormation `AWS::Logs::Destination`.",
|
415 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as logs from '@aws-cdk/aws-logs';\nconst cfnDestination = new logs.CfnDestination(this, 'MyCfnDestination', {\n destinationName: 'destinationName',\n roleArn: 'roleArn',\n targetArn: 'targetArn',\n\n // the properties below are optional\n destinationPolicy: 'destinationPolicy',\n});"
|
416 | },
|
417 | "fqn": "@aws-cdk/aws-logs.CfnDestination",
|
418 | "initializer": {
|
419 | "docs": {
|
420 | "stability": "external",
|
421 | "summary": "Create a new `AWS::Logs::Destination`."
|
422 | },
|
423 | "locationInModule": {
|
424 | "filename": "lib/logs.generated.ts",
|
425 | "line": 183
|
426 | },
|
427 | "parameters": [
|
428 | {
|
429 | "docs": {
|
430 | "summary": "- scope in which this resource is defined."
|
431 | },
|
432 | "name": "scope",
|
433 | "type": {
|
434 | "fqn": "@aws-cdk/core.Construct"
|
435 | }
|
436 | },
|
437 | {
|
438 | "docs": {
|
439 | "summary": "- scoped id of the resource."
|
440 | },
|
441 | "name": "id",
|
442 | "type": {
|
443 | "primitive": "string"
|
444 | }
|
445 | },
|
446 | {
|
447 | "docs": {
|
448 | "summary": "- resource properties."
|
449 | },
|
450 | "name": "props",
|
451 | "type": {
|
452 | "fqn": "@aws-cdk/aws-logs.CfnDestinationProps"
|
453 | }
|
454 | }
|
455 | ]
|
456 | },
|
457 | "interfaces": [
|
458 | "@aws-cdk/core.IInspectable"
|
459 | ],
|
460 | "kind": "class",
|
461 | "locationInModule": {
|
462 | "filename": "lib/logs.generated.ts",
|
463 | "line": 117
|
464 | },
|
465 | "methods": [
|
466 | {
|
467 | "docs": {
|
468 | "stability": "external",
|
469 | "summary": "Examines the CloudFormation resource and discloses attributes."
|
470 | },
|
471 | "locationInModule": {
|
472 | "filename": "lib/logs.generated.ts",
|
473 | "line": 202
|
474 | },
|
475 | "name": "inspect",
|
476 | "overrides": "@aws-cdk/core.IInspectable",
|
477 | "parameters": [
|
478 | {
|
479 | "docs": {
|
480 | "summary": "- tree inspector to collect and process attributes."
|
481 | },
|
482 | "name": "inspector",
|
483 | "type": {
|
484 | "fqn": "@aws-cdk/core.TreeInspector"
|
485 | }
|
486 | }
|
487 | ]
|
488 | },
|
489 | {
|
490 | "docs": {
|
491 | "stability": "external"
|
492 | },
|
493 | "locationInModule": {
|
494 | "filename": "lib/logs.generated.ts",
|
495 | "line": 216
|
496 | },
|
497 | "name": "renderProperties",
|
498 | "overrides": "@aws-cdk/core.CfnResource",
|
499 | "parameters": [
|
500 | {
|
501 | "name": "props",
|
502 | "type": {
|
503 | "collection": {
|
504 | "elementtype": {
|
505 | "primitive": "any"
|
506 | },
|
507 | "kind": "map"
|
508 | }
|
509 | }
|
510 | }
|
511 | ],
|
512 | "protected": true,
|
513 | "returns": {
|
514 | "type": {
|
515 | "collection": {
|
516 | "elementtype": {
|
517 | "primitive": "any"
|
518 | },
|
519 | "kind": "map"
|
520 | }
|
521 | }
|
522 | }
|
523 | }
|
524 | ],
|
525 | "name": "CfnDestination",
|
526 | "properties": [
|
527 | {
|
528 | "const": true,
|
529 | "docs": {
|
530 | "stability": "external",
|
531 | "summary": "The CloudFormation resource type name for this resource class."
|
532 | },
|
533 | "immutable": true,
|
534 | "locationInModule": {
|
535 | "filename": "lib/logs.generated.ts",
|
536 | "line": 121
|
537 | },
|
538 | "name": "CFN_RESOURCE_TYPE_NAME",
|
539 | "static": true,
|
540 | "type": {
|
541 | "primitive": "string"
|
542 | }
|
543 | },
|
544 | {
|
545 | "docs": {
|
546 | "custom": {
|
547 | "cloudformationAttribute": "Arn"
|
548 | },
|
549 | "stability": "external",
|
550 | "summary": "The ARN of the CloudWatch Logs destination, such as `arn:aws:logs:us-west-1:123456789012:destination:MyDestination` ."
|
551 | },
|
552 | "immutable": true,
|
553 | "locationInModule": {
|
554 | "filename": "lib/logs.generated.ts",
|
555 | "line": 146
|
556 | },
|
557 | "name": "attrArn",
|
558 | "type": {
|
559 | "primitive": "string"
|
560 | }
|
561 | },
|
562 | {
|
563 | "docs": {
|
564 | "stability": "external"
|
565 | },
|
566 | "immutable": true,
|
567 | "locationInModule": {
|
568 | "filename": "lib/logs.generated.ts",
|
569 | "line": 207
|
570 | },
|
571 | "name": "cfnProperties",
|
572 | "overrides": "@aws-cdk/core.CfnResource",
|
573 | "protected": true,
|
574 | "type": {
|
575 | "collection": {
|
576 | "elementtype": {
|
577 | "primitive": "any"
|
578 | },
|
579 | "kind": "map"
|
580 | }
|
581 | }
|
582 | },
|
583 | {
|
584 | "docs": {
|
585 | "custom": {
|
586 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-destinationname"
|
587 | },
|
588 | "stability": "external",
|
589 | "summary": "The name of the destination."
|
590 | },
|
591 | "locationInModule": {
|
592 | "filename": "lib/logs.generated.ts",
|
593 | "line": 153
|
594 | },
|
595 | "name": "destinationName",
|
596 | "type": {
|
597 | "primitive": "string"
|
598 | }
|
599 | },
|
600 | {
|
601 | "docs": {
|
602 | "custom": {
|
603 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-rolearn"
|
604 | },
|
605 | "stability": "external",
|
606 | "summary": "The ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource."
|
607 | },
|
608 | "locationInModule": {
|
609 | "filename": "lib/logs.generated.ts",
|
610 | "line": 160
|
611 | },
|
612 | "name": "roleArn",
|
613 | "type": {
|
614 | "primitive": "string"
|
615 | }
|
616 | },
|
617 | {
|
618 | "docs": {
|
619 | "custom": {
|
620 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-targetarn"
|
621 | },
|
622 | "stability": "external",
|
623 | "summary": "The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream)."
|
624 | },
|
625 | "locationInModule": {
|
626 | "filename": "lib/logs.generated.ts",
|
627 | "line": 167
|
628 | },
|
629 | "name": "targetArn",
|
630 | "type": {
|
631 | "primitive": "string"
|
632 | }
|
633 | },
|
634 | {
|
635 | "docs": {
|
636 | "custom": {
|
637 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-destinationpolicy"
|
638 | },
|
639 | "stability": "external",
|
640 | "summary": "An IAM policy document that governs which AWS accounts can create subscription filters against this destination."
|
641 | },
|
642 | "locationInModule": {
|
643 | "filename": "lib/logs.generated.ts",
|
644 | "line": 174
|
645 | },
|
646 | "name": "destinationPolicy",
|
647 | "optional": true,
|
648 | "type": {
|
649 | "primitive": "string"
|
650 | }
|
651 | }
|
652 | ],
|
653 | "symbolId": "lib/logs.generated:CfnDestination"
|
654 | },
|
655 | "@aws-cdk/aws-logs.CfnDestinationProps": {
|
656 | "assembly": "@aws-cdk/aws-logs",
|
657 | "datatype": true,
|
658 | "docs": {
|
659 | "custom": {
|
660 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html",
|
661 | "exampleMetadata": "fixture=_generated"
|
662 | },
|
663 | "stability": "external",
|
664 | "summary": "Properties for defining a `CfnDestination`.",
|
665 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as logs from '@aws-cdk/aws-logs';\nconst cfnDestinationProps: logs.CfnDestinationProps = {\n destinationName: 'destinationName',\n roleArn: 'roleArn',\n targetArn: 'targetArn',\n\n // the properties below are optional\n destinationPolicy: 'destinationPolicy',\n};"
|
666 | },
|
667 | "fqn": "@aws-cdk/aws-logs.CfnDestinationProps",
|
668 | "kind": "interface",
|
669 | "locationInModule": {
|
670 | "filename": "lib/logs.generated.ts",
|
671 | "line": 19
|
672 | },
|
673 | "name": "CfnDestinationProps",
|
674 | "properties": [
|
675 | {
|
676 | "abstract": true,
|
677 | "docs": {
|
678 | "custom": {
|
679 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-destinationname"
|
680 | },
|
681 | "stability": "external",
|
682 | "summary": "The name of the destination."
|
683 | },
|
684 | "immutable": true,
|
685 | "locationInModule": {
|
686 | "filename": "lib/logs.generated.ts",
|
687 | "line": 26
|
688 | },
|
689 | "name": "destinationName",
|
690 | "type": {
|
691 | "primitive": "string"
|
692 | }
|
693 | },
|
694 | {
|
695 | "abstract": true,
|
696 | "docs": {
|
697 | "custom": {
|
698 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-rolearn"
|
699 | },
|
700 | "stability": "external",
|
701 | "summary": "The ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource."
|
702 | },
|
703 | "immutable": true,
|
704 | "locationInModule": {
|
705 | "filename": "lib/logs.generated.ts",
|
706 | "line": 33
|
707 | },
|
708 | "name": "roleArn",
|
709 | "type": {
|
710 | "primitive": "string"
|
711 | }
|
712 | },
|
713 | {
|
714 | "abstract": true,
|
715 | "docs": {
|
716 | "custom": {
|
717 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-targetarn"
|
718 | },
|
719 | "stability": "external",
|
720 | "summary": "The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream)."
|
721 | },
|
722 | "immutable": true,
|
723 | "locationInModule": {
|
724 | "filename": "lib/logs.generated.ts",
|
725 | "line": 40
|
726 | },
|
727 | "name": "targetArn",
|
728 | "type": {
|
729 | "primitive": "string"
|
730 | }
|
731 | },
|
732 | {
|
733 | "abstract": true,
|
734 | "docs": {
|
735 | "custom": {
|
736 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-destinationpolicy"
|
737 | },
|
738 | "stability": "external",
|
739 | "summary": "An IAM policy document that governs which AWS accounts can create subscription filters against this destination."
|
740 | },
|
741 | "immutable": true,
|
742 | "locationInModule": {
|
743 | "filename": "lib/logs.generated.ts",
|
744 | "line": 47
|
745 | },
|
746 | "name": "destinationPolicy",
|
747 | "optional": true,
|
748 | "type": {
|
749 | "primitive": "string"
|
750 | }
|
751 | }
|
752 | ],
|
753 | "symbolId": "lib/logs.generated:CfnDestinationProps"
|
754 | },
|
755 | "@aws-cdk/aws-logs.CfnLogGroup": {
|
756 | "assembly": "@aws-cdk/aws-logs",
|
757 | "base": "@aws-cdk/core.CfnResource",
|
758 | "docs": {
|
759 | "custom": {
|
760 | "cloudformationResource": "AWS::Logs::LogGroup",
|
761 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html",
|
762 | "exampleMetadata": "fixture=_generated"
|
763 | },
|
764 | "remarks": "The `AWS::Logs::LogGroup` resource specifies a log group. A log group defines common properties for log streams, such as their retention and access control rules. Each log stream must belong to one log group.\n\nYou can create up to 1,000,000 log groups per Region per account. You must use the following guidelines when naming a log group:\n\n- Log group names must be unique within a Region for an AWS account.\n- Log group names can be between 1 and 512 characters long.\n- Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).",
|
765 | "stability": "external",
|
766 | "summary": "A CloudFormation `AWS::Logs::LogGroup`.",
|
767 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as logs from '@aws-cdk/aws-logs';\n\ndeclare const dataProtectionPolicy: any;\nconst cfnLogGroup = new logs.CfnLogGroup(this, 'MyCfnLogGroup', /* all optional props */ {\n dataProtectionPolicy: dataProtectionPolicy,\n kmsKeyId: 'kmsKeyId',\n logGroupName: 'logGroupName',\n retentionInDays: 123,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});"
|
768 | },
|
769 | "fqn": "@aws-cdk/aws-logs.CfnLogGroup",
|
770 | "initializer": {
|
771 | "docs": {
|
772 | "stability": "external",
|
773 | "summary": "Create a new `AWS::Logs::LogGroup`."
|
774 | },
|
775 | "locationInModule": {
|
776 | "filename": "lib/logs.generated.ts",
|
777 | "line": 437
|
778 | },
|
779 | "parameters": [
|
780 | {
|
781 | "docs": {
|
782 | "summary": "- scope in which this resource is defined."
|
783 | },
|
784 | "name": "scope",
|
785 | "type": {
|
786 | "fqn": "@aws-cdk/core.Construct"
|
787 | }
|
788 | },
|
789 | {
|
790 | "docs": {
|
791 | "summary": "- scoped id of the resource."
|
792 | },
|
793 | "name": "id",
|
794 | "type": {
|
795 | "primitive": "string"
|
796 | }
|
797 | },
|
798 | {
|
799 | "docs": {
|
800 | "summary": "- resource properties."
|
801 | },
|
802 | "name": "props",
|
803 | "optional": true,
|
804 | "type": {
|
805 | "fqn": "@aws-cdk/aws-logs.CfnLogGroupProps"
|
806 | }
|
807 | }
|
808 | ]
|
809 | },
|
810 | "interfaces": [
|
811 | "@aws-cdk/core.IInspectable"
|
812 | ],
|
813 | "kind": "class",
|
814 | "locationInModule": {
|
815 | "filename": "lib/logs.generated.ts",
|
816 | "line": 352
|
817 | },
|
818 | "methods": [
|
819 | {
|
820 | "docs": {
|
821 | "stability": "external",
|
822 | "summary": "Examines the CloudFormation resource and discloses attributes."
|
823 | },
|
824 | "locationInModule": {
|
825 | "filename": "lib/logs.generated.ts",
|
826 | "line": 459
|
827 | },
|
828 | "name": "inspect",
|
829 | "overrides": "@aws-cdk/core.IInspectable",
|
830 | "parameters": [
|
831 | {
|
832 | "docs": {
|
833 | "summary": "- tree inspector to collect and process attributes."
|
834 | },
|
835 | "name": "inspector",
|
836 | "type": {
|
837 | "fqn": "@aws-cdk/core.TreeInspector"
|
838 | }
|
839 | }
|
840 | ]
|
841 | },
|
842 | {
|
843 | "docs": {
|
844 | "stability": "external"
|
845 | },
|
846 | "locationInModule": {
|
847 | "filename": "lib/logs.generated.ts",
|
848 | "line": 474
|
849 | },
|
850 | "name": "renderProperties",
|
851 | "overrides": "@aws-cdk/core.CfnResource",
|
852 | "parameters": [
|
853 | {
|
854 | "name": "props",
|
855 | "type": {
|
856 | "collection": {
|
857 | "elementtype": {
|
858 | "primitive": "any"
|
859 | },
|
860 | "kind": "map"
|
861 | }
|
862 | }
|
863 | }
|
864 | ],
|
865 | "protected": true,
|
866 | "returns": {
|
867 | "type": {
|
868 | "collection": {
|
869 | "elementtype": {
|
870 | "primitive": "any"
|
871 | },
|
872 | "kind": "map"
|
873 | }
|
874 | }
|
875 | }
|
876 | }
|
877 | ],
|
878 | "name": "CfnLogGroup",
|
879 | "properties": [
|
880 | {
|
881 | "const": true,
|
882 | "docs": {
|
883 | "stability": "external",
|
884 | "summary": "The CloudFormation resource type name for this resource class."
|
885 | },
|
886 | "immutable": true,
|
887 | "locationInModule": {
|
888 | "filename": "lib/logs.generated.ts",
|
889 | "line": 356
|
890 | },
|
891 | "name": "CFN_RESOURCE_TYPE_NAME",
|
892 | "static": true,
|
893 | "type": {
|
894 | "primitive": "string"
|
895 | }
|
896 | },
|
897 | {
|
898 | "docs": {
|
899 | "custom": {
|
900 | "cloudformationAttribute": "Arn"
|
901 | },
|
902 | "stability": "external",
|
903 | "summary": "The ARN of the log group, such as `arn:aws:logs:us-west-1:123456789012:log-group:/mystack-testgroup-12ABC1AB12A1:*`."
|
904 | },
|
905 | "immutable": true,
|
906 | "locationInModule": {
|
907 | "filename": "lib/logs.generated.ts",
|
908 | "line": 381
|
909 | },
|
910 | "name": "attrArn",
|
911 | "type": {
|
912 | "primitive": "string"
|
913 | }
|
914 | },
|
915 | {
|
916 | "docs": {
|
917 | "stability": "external"
|
918 | },
|
919 | "immutable": true,
|
920 | "locationInModule": {
|
921 | "filename": "lib/logs.generated.ts",
|
922 | "line": 464
|
923 | },
|
924 | "name": "cfnProperties",
|
925 | "overrides": "@aws-cdk/core.CfnResource",
|
926 | "protected": true,
|
927 | "type": {
|
928 | "collection": {
|
929 | "elementtype": {
|
930 | "primitive": "any"
|
931 | },
|
932 | "kind": "map"
|
933 | }
|
934 | }
|
935 | },
|
936 | {
|
937 | "docs": {
|
938 | "custom": {
|
939 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-tags"
|
940 | },
|
941 | "remarks": "For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .",
|
942 | "stability": "external",
|
943 | "summary": "An array of key-value pairs to apply to the log group."
|
944 | },
|
945 | "immutable": true,
|
946 | "locationInModule": {
|
947 | "filename": "lib/logs.generated.ts",
|
948 | "line": 428
|
949 | },
|
950 | "name": "tags",
|
951 | "type": {
|
952 | "fqn": "@aws-cdk/core.TagManager"
|
953 | }
|
954 | },
|
955 | {
|
956 | "docs": {
|
957 | "custom": {
|
958 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-dataprotectionpolicy"
|
959 | },
|
960 | "remarks": "A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. When a user who does not have permission to view masked data views a log event that includes masked data, the sensitive data is replaced by asterisks.\n\nFor more information, including a list of types of data that can be audited and masked, see [Protect sensitive log data with masking](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html) .",
|
961 | "stability": "external",
|
962 | "summary": "Creates a data protection policy and assigns it to the log group."
|
963 | },
|
964 | "locationInModule": {
|
965 | "filename": "lib/logs.generated.ts",
|
966 | "line": 390
|
967 | },
|
968 | "name": "dataProtectionPolicy",
|
969 | "type": {
|
970 | "primitive": "any"
|
971 | }
|
972 | },
|
973 | {
|
974 | "docs": {
|
975 | "custom": {
|
976 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-kmskeyid"
|
977 | },
|
978 | "remarks": "To associate an AWS KMS key with the log group, specify the ARN of that KMS key here. If you do so, ingested data is encrypted using this key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs . This enables CloudWatch Logs to decrypt this data whenever it is requested.\n\nIf you attempt to associate a KMS key with the log group but the KMS key doesn't exist or is deactivated, you will receive an `InvalidParameterException` error.\n\nLog group data is always encrypted in CloudWatch Logs . If you omit this key, the encryption does not use AWS KMS . For more information, see [Encrypt log data in CloudWatch Logs using AWS Key Management Service](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html)",
|
979 | "stability": "external",
|
980 | "summary": "The Amazon Resource Name (ARN) of the AWS KMS key to use when encrypting log data."
|
981 | },
|
982 | "locationInModule": {
|
983 | "filename": "lib/logs.generated.ts",
|
984 | "line": 403
|
985 | },
|
986 | "name": "kmsKeyId",
|
987 | "optional": true,
|
988 | "type": {
|
989 | "primitive": "string"
|
990 | }
|
991 | },
|
992 | {
|
993 | "docs": {
|
994 | "custom": {
|
995 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-loggroupname"
|
996 | },
|
997 | "remarks": "If you don't specify a name, AWS CloudFormation generates a unique ID for the log group.",
|
998 | "stability": "external",
|
999 | "summary": "The name of the log group."
|
1000 | },
|
1001 | "locationInModule": {
|
1002 | "filename": "lib/logs.generated.ts",
|
1003 | "line": 410
|
1004 | },
|
1005 | "name": "logGroupName",
|
1006 | "optional": true,
|
1007 | "type": {
|
1008 | "primitive": "string"
|
1009 | }
|
1010 | },
|
1011 | {
|
1012 | "docs": {
|
1013 | "custom": {
|
1014 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-retentionindays"
|
1015 | },
|
1016 | "remarks": "Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653.\n\nTo set a log group so that its log events do not expire, use [DeleteRetentionPolicy](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html) .",
|
1017 | "stability": "external",
|
1018 | "summary": "The number of days to retain the log events in the specified log group."
|
1019 | },
|
1020 | "locationInModule": {
|
1021 | "filename": "lib/logs.generated.ts",
|
1022 | "line": 419
|
1023 | },
|
1024 | "name": "retentionInDays",
|
1025 | "optional": true,
|
1026 | "type": {
|
1027 | "primitive": "number"
|
1028 | }
|
1029 | }
|
1030 | ],
|
1031 | "symbolId": "lib/logs.generated:CfnLogGroup"
|
1032 | },
|
1033 | "@aws-cdk/aws-logs.CfnLogGroupProps": {
|
1034 | "assembly": "@aws-cdk/aws-logs",
|
1035 | "datatype": true,
|
1036 | "docs": {
|
1037 | "custom": {
|
1038 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html",
|
1039 | "exampleMetadata": "fixture=_generated"
|
1040 | },
|
1041 | "stability": "external",
|
1042 | "summary": "Properties for defining a `CfnLogGroup`.",
|
1043 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as logs from '@aws-cdk/aws-logs';\n\ndeclare const dataProtectionPolicy: any;\nconst cfnLogGroupProps: logs.CfnLogGroupProps = {\n dataProtectionPolicy: dataProtectionPolicy,\n kmsKeyId: 'kmsKeyId',\n logGroupName: 'logGroupName',\n retentionInDays: 123,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};"
|
1044 | },
|
1045 | "fqn": "@aws-cdk/aws-logs.CfnLogGroupProps",
|
1046 | "kind": "interface",
|
1047 | "locationInModule": {
|
1048 | "filename": "lib/logs.generated.ts",
|
1049 | "line": 229
|
1050 | },
|
1051 | "name": "CfnLogGroupProps",
|
1052 | "properties": [
|
1053 | {
|
1054 | "abstract": true,
|
1055 | "docs": {
|
1056 | "custom": {
|
1057 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-dataprotectionpolicy"
|
1058 | },
|
1059 | "remarks": "A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. When a user who does not have permission to view masked data views a log event that includes masked data, the sensitive data is replaced by asterisks.\n\nFor more information, including a list of types of data that can be audited and masked, see [Protect sensitive log data with masking](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html) .",
|
1060 | "stability": "external",
|
1061 | "summary": "Creates a data protection policy and assigns it to the log group."
|
1062 | },
|
1063 | "immutable": true,
|
1064 | "locationInModule": {
|
1065 | "filename": "lib/logs.generated.ts",
|
1066 | "line": 238
|
1067 | },
|
1068 | "name": "dataProtectionPolicy",
|
1069 | "optional": true,
|
1070 | "type": {
|
1071 | "primitive": "any"
|
1072 | }
|
1073 | },
|
1074 | {
|
1075 | "abstract": true,
|
1076 | "docs": {
|
1077 | "custom": {
|
1078 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-kmskeyid"
|
1079 | },
|
1080 | "remarks": "To associate an AWS KMS key with the log group, specify the ARN of that KMS key here. If you do so, ingested data is encrypted using this key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs . This enables CloudWatch Logs to decrypt this data whenever it is requested.\n\nIf you attempt to associate a KMS key with the log group but the KMS key doesn't exist or is deactivated, you will receive an `InvalidParameterException` error.\n\nLog group data is always encrypted in CloudWatch Logs . If you omit this key, the encryption does not use AWS KMS . For more information, see [Encrypt log data in CloudWatch Logs using AWS Key Management Service](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html)",
|
1081 | "stability": "external",
|
1082 | "summary": "The Amazon Resource Name (ARN) of the AWS KMS key to use when encrypting log data."
|
1083 | },
|
1084 | "immutable": true,
|
1085 | "locationInModule": {
|
1086 | "filename": "lib/logs.generated.ts",
|
1087 | "line": 251
|
1088 | },
|
1089 | "name": "kmsKeyId",
|
1090 | "optional": true,
|
1091 | "type": {
|
1092 | "primitive": "string"
|
1093 | }
|
1094 | },
|
1095 | {
|
1096 | "abstract": true,
|
1097 | "docs": {
|
1098 | "custom": {
|
1099 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-loggroupname"
|
1100 | },
|
1101 | "remarks": "If you don't specify a name, AWS CloudFormation generates a unique ID for the log group.",
|
1102 | "stability": "external",
|
1103 | "summary": "The name of the log group."
|
1104 | },
|
1105 | "immutable": true,
|
1106 | "locationInModule": {
|
1107 | "filename": "lib/logs.generated.ts",
|
1108 | "line": 258
|
1109 | },
|
1110 | "name": "logGroupName",
|
1111 | "optional": true,
|
1112 | "type": {
|
1113 | "primitive": "string"
|
1114 | }
|
1115 | },
|
1116 | {
|
1117 | "abstract": true,
|
1118 | "docs": {
|
1119 | "custom": {
|
1120 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-retentionindays"
|
1121 | },
|
1122 | "remarks": "Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653.\n\nTo set a log group so that its log events do not expire, use [DeleteRetentionPolicy](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html) .",
|
1123 | "stability": "external",
|
1124 | "summary": "The number of days to retain the log events in the specified log group."
|
1125 | },
|
1126 | "immutable": true,
|
1127 | "locationInModule": {
|
1128 | "filename": "lib/logs.generated.ts",
|
1129 | "line": 267
|
1130 | },
|
1131 | "name": "retentionInDays",
|
1132 | "optional": true,
|
1133 | "type": {
|
1134 | "primitive": "number"
|
1135 | }
|
1136 | },
|
1137 | {
|
1138 | "abstract": true,
|
1139 | "docs": {
|
1140 | "custom": {
|
1141 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-tags"
|
1142 | },
|
1143 | "remarks": "For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .",
|
1144 | "stability": "external",
|
1145 | "summary": "An array of key-value pairs to apply to the log group."
|
1146 | },
|
1147 | "immutable": true,
|
1148 | "locationInModule": {
|
1149 | "filename": "lib/logs.generated.ts",
|
1150 | "line": 276
|
1151 | },
|
1152 | "name": "tags",
|
1153 | "optional": true,
|
1154 | "type": {
|
1155 | "collection": {
|
1156 | "elementtype": {
|
1157 | "fqn": "@aws-cdk/core.CfnTag"
|
1158 | },
|
1159 | "kind": "array"
|
1160 | }
|
1161 | }
|
1162 | }
|
1163 | ],
|
1164 | "symbolId": "lib/logs.generated:CfnLogGroupProps"
|
1165 | },
|
1166 | "@aws-cdk/aws-logs.CfnLogStream": {
|
1167 | "assembly": "@aws-cdk/aws-logs",
|
1168 | "base": "@aws-cdk/core.CfnResource",
|
1169 | "docs": {
|
1170 | "custom": {
|
1171 | "cloudformationResource": "AWS::Logs::LogStream",
|
1172 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html",
|
1173 | "exampleMetadata": "fixture=_generated"
|
1174 | },
|
1175 | "remarks": "The `AWS::Logs::LogStream` resource specifies an Amazon CloudWatch Logs log stream in a specific log group. A log stream represents the sequence of events coming from an application instance or resource that you are monitoring.\n\nThere is no limit on the number of log streams that you can create for a log group.\n\nYou must use the following guidelines when naming a log stream:\n\n- Log stream names must be unique within the log group.\n- Log stream names can be between 1 and 512 characters long.\n- The ':' (colon) and '*' (asterisk) characters are not allowed.",
|
1176 | "stability": "external",
|
1177 | "summary": "A CloudFormation `AWS::Logs::LogStream`.",
|
1178 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as logs from '@aws-cdk/aws-logs';\nconst cfnLogStream = new logs.CfnLogStream(this, 'MyCfnLogStream', {\n logGroupName: 'logGroupName',\n\n // the properties below are optional\n logStreamName: 'logStreamName',\n});"
|
1179 | },
|
1180 | "fqn": "@aws-cdk/aws-logs.CfnLogStream",
|
1181 | "initializer": {
|
1182 | "docs": {
|
1183 | "stability": "external",
|
1184 | "summary": "Create a new `AWS::Logs::LogStream`."
|
1185 | },
|
1186 | "locationInModule": {
|
1187 | "filename": "lib/logs.generated.ts",
|
1188 | "line": 623
|
1189 | },
|
1190 | "parameters": [
|
1191 | {
|
1192 | "docs": {
|
1193 | "summary": "- scope in which this resource is defined."
|
1194 | },
|
1195 | "name": "scope",
|
1196 | "type": {
|
1197 | "fqn": "@aws-cdk/core.Construct"
|
1198 | }
|
1199 | },
|
1200 | {
|
1201 | "docs": {
|
1202 | "summary": "- scoped id of the resource."
|
1203 | },
|
1204 | "name": "id",
|
1205 | "type": {
|
1206 | "primitive": "string"
|
1207 | }
|
1208 | },
|
1209 | {
|
1210 | "docs": {
|
1211 | "summary": "- resource properties."
|
1212 | },
|
1213 | "name": "props",
|
1214 | "type": {
|
1215 | "fqn": "@aws-cdk/aws-logs.CfnLogStreamProps"
|
1216 | }
|
1217 | }
|
1218 | ]
|
1219 | },
|
1220 | "interfaces": [
|
1221 | "@aws-cdk/core.IInspectable"
|
1222 | ],
|
1223 | "kind": "class",
|
1224 | "locationInModule": {
|
1225 | "filename": "lib/logs.generated.ts",
|
1226 | "line": 571
|
1227 | },
|
1228 | "methods": [
|
1229 | {
|
1230 | "docs": {
|
1231 | "stability": "external",
|
1232 | "summary": "Examines the CloudFormation resource and discloses attributes."
|
1233 | },
|
1234 | "locationInModule": {
|
1235 | "filename": "lib/logs.generated.ts",
|
1236 | "line": 638
|
1237 | },
|
1238 | "name": "inspect",
|
1239 | "overrides": "@aws-cdk/core.IInspectable",
|
1240 | "parameters": [
|
1241 | {
|
1242 | "docs": {
|
1243 | "summary": "- tree inspector to collect and process attributes."
|
1244 | },
|
1245 | "name": "inspector",
|
1246 | "type": {
|
1247 | "fqn": "@aws-cdk/core.TreeInspector"
|
1248 | }
|
1249 | }
|
1250 | ]
|
1251 | },
|
1252 | {
|
1253 | "docs": {
|
1254 | "stability": "external"
|
1255 | },
|
1256 | "locationInModule": {
|
1257 | "filename": "lib/logs.generated.ts",
|
1258 | "line": 650
|
1259 | },
|
1260 | "name": "renderProperties",
|
1261 | "overrides": "@aws-cdk/core.CfnResource",
|
1262 | "parameters": [
|
1263 | {
|
1264 | "name": "props",
|
1265 | "type": {
|
1266 | "collection": {
|
1267 | "elementtype": {
|
1268 | "primitive": "any"
|
1269 | },
|
1270 | "kind": "map"
|
1271 | }
|
1272 | }
|
1273 | }
|
1274 | ],
|
1275 | "protected": true,
|
1276 | "returns": {
|
1277 | "type": {
|
1278 | "collection": {
|
1279 | "elementtype": {
|
1280 | "primitive": "any"
|
1281 | },
|
1282 | "kind": "map"
|
1283 | }
|
1284 | }
|
1285 | }
|
1286 | }
|
1287 | ],
|
1288 | "name": "CfnLogStream",
|
1289 | "properties": [
|
1290 | {
|
1291 | "const": true,
|
1292 | "docs": {
|
1293 | "stability": "external",
|
1294 | "summary": "The CloudFormation resource type name for this resource class."
|
1295 | },
|
1296 | "immutable": true,
|
1297 | "locationInModule": {
|
1298 | "filename": "lib/logs.generated.ts",
|
1299 | "line": 575
|
1300 | },
|
1301 | "name": "CFN_RESOURCE_TYPE_NAME",
|
1302 | "static": true,
|
1303 | "type": {
|
1304 | "primitive": "string"
|
1305 | }
|
1306 | },
|
1307 | {
|
1308 | "docs": {
|
1309 | "custom": {
|
1310 | "cloudformationAttribute": "Id"
|
1311 | },
|
1312 | "stability": "external"
|
1313 | },
|
1314 | "immutable": true,
|
1315 | "locationInModule": {
|
1316 | "filename": "lib/logs.generated.ts",
|
1317 | "line": 600
|
1318 | },
|
1319 | "name": "attrId",
|
1320 | "type": {
|
1321 | "primitive": "string"
|
1322 | }
|
1323 | },
|
1324 | {
|
1325 | "docs": {
|
1326 | "stability": "external"
|
1327 | },
|
1328 | "immutable": true,
|
1329 | "locationInModule": {
|
1330 | "filename": "lib/logs.generated.ts",
|
1331 | "line": 643
|
1332 | },
|
1333 | "name": "cfnProperties",
|
1334 | "overrides": "@aws-cdk/core.CfnResource",
|
1335 | "protected": true,
|
1336 | "type": {
|
1337 | "collection": {
|
1338 | "elementtype": {
|
1339 | "primitive": "any"
|
1340 | },
|
1341 | "kind": "map"
|
1342 | }
|
1343 | }
|
1344 | },
|
1345 | {
|
1346 | "docs": {
|
1347 | "custom": {
|
1348 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html#cfn-logs-logstream-loggroupname"
|
1349 | },
|
1350 | "stability": "external",
|
1351 | "summary": "The name of the log group where the log stream is created."
|
1352 | },
|
1353 | "locationInModule": {
|
1354 | "filename": "lib/logs.generated.ts",
|
1355 | "line": 607
|
1356 | },
|
1357 | "name": "logGroupName",
|
1358 | "type": {
|
1359 | "primitive": "string"
|
1360 | }
|
1361 | },
|
1362 | {
|
1363 | "docs": {
|
1364 | "custom": {
|
1365 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html#cfn-logs-logstream-logstreamname"
|
1366 | },
|
1367 | "remarks": "The name must be unique within the log group.",
|
1368 | "stability": "external",
|
1369 | "summary": "The name of the log stream."
|
1370 | },
|
1371 | "locationInModule": {
|
1372 | "filename": "lib/logs.generated.ts",
|
1373 | "line": 614
|
1374 | },
|
1375 | "name": "logStreamName",
|
1376 | "optional": true,
|
1377 | "type": {
|
1378 | "primitive": "string"
|
1379 | }
|
1380 | }
|
1381 | ],
|
1382 | "symbolId": "lib/logs.generated:CfnLogStream"
|
1383 | },
|
1384 | "@aws-cdk/aws-logs.CfnLogStreamProps": {
|
1385 | "assembly": "@aws-cdk/aws-logs",
|
1386 | "datatype": true,
|
1387 | "docs": {
|
1388 | "custom": {
|
1389 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html",
|
1390 | "exampleMetadata": "fixture=_generated"
|
1391 | },
|
1392 | "stability": "external",
|
1393 | "summary": "Properties for defining a `CfnLogStream`.",
|
1394 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as logs from '@aws-cdk/aws-logs';\nconst cfnLogStreamProps: logs.CfnLogStreamProps = {\n logGroupName: 'logGroupName',\n\n // the properties below are optional\n logStreamName: 'logStreamName',\n};"
|
1395 | },
|
1396 | "fqn": "@aws-cdk/aws-logs.CfnLogStreamProps",
|
1397 | "kind": "interface",
|
1398 | "locationInModule": {
|
1399 | "filename": "lib/logs.generated.ts",
|
1400 | "line": 487
|
1401 | },
|
1402 | "name": "CfnLogStreamProps",
|
1403 | "properties": [
|
1404 | {
|
1405 | "abstract": true,
|
1406 | "docs": {
|
1407 | "custom": {
|
1408 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html#cfn-logs-logstream-loggroupname"
|
1409 | },
|
1410 | "stability": "external",
|
1411 | "summary": "The name of the log group where the log stream is created."
|
1412 | },
|
1413 | "immutable": true,
|
1414 | "locationInModule": {
|
1415 | "filename": "lib/logs.generated.ts",
|
1416 | "line": 494
|
1417 | },
|
1418 | "name": "logGroupName",
|
1419 | "type": {
|
1420 | "primitive": "string"
|
1421 | }
|
1422 | },
|
1423 | {
|
1424 | "abstract": true,
|
1425 | "docs": {
|
1426 | "custom": {
|
1427 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html#cfn-logs-logstream-logstreamname"
|
1428 | },
|
1429 | "remarks": "The name must be unique within the log group.",
|
1430 | "stability": "external",
|
1431 | "summary": "The name of the log stream."
|
1432 | },
|
1433 | "immutable": true,
|
1434 | "locationInModule": {
|
1435 | "filename": "lib/logs.generated.ts",
|
1436 | "line": 501
|
1437 | },
|
1438 | "name": "logStreamName",
|
1439 | "optional": true,
|
1440 | "type": {
|
1441 | "primitive": "string"
|
1442 | }
|
1443 | }
|
1444 | ],
|
1445 | "symbolId": "lib/logs.generated:CfnLogStreamProps"
|
1446 | },
|
1447 | "@aws-cdk/aws-logs.CfnMetricFilter": {
|
1448 | "assembly": "@aws-cdk/aws-logs",
|
1449 | "base": "@aws-cdk/core.CfnResource",
|
1450 | "docs": {
|
1451 | "custom": {
|
1452 | "cloudformationResource": "AWS::Logs::MetricFilter",
|
1453 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html",
|
1454 | "exampleMetadata": "fixture=_generated"
|
1455 | },
|
1456 | "remarks": "The `AWS::Logs::MetricFilter` resource specifies a metric filter that describes how CloudWatch Logs extracts information from logs and transforms it into Amazon CloudWatch metrics. If you have multiple metric filters that are associated with a log group, all the filters are applied to the log streams in that group.\n\nThe maximum number of metric filters that can be associated with a log group is 100.",
|
1457 | "stability": "external",
|
1458 | "summary": "A CloudFormation `AWS::Logs::MetricFilter`.",
|
1459 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as logs from '@aws-cdk/aws-logs';\nconst cfnMetricFilter = new logs.CfnMetricFilter(this, 'MyCfnMetricFilter', {\n filterPattern: 'filterPattern',\n logGroupName: 'logGroupName',\n metricTransformations: [{\n metricName: 'metricName',\n metricNamespace: 'metricNamespace',\n metricValue: 'metricValue',\n\n // the properties below are optional\n defaultValue: 123,\n dimensions: [{\n key: 'key',\n value: 'value',\n }],\n unit: 'unit',\n }],\n\n // the properties below are optional\n filterName: 'filterName',\n});"
|
1460 | },
|
1461 | "fqn": "@aws-cdk/aws-logs.CfnMetricFilter",
|
1462 | "initializer": {
|
1463 | "docs": {
|
1464 | "stability": "external",
|
1465 | "summary": "Create a new `AWS::Logs::MetricFilter`."
|
1466 | },
|
1467 | "locationInModule": {
|
1468 | "filename": "lib/logs.generated.ts",
|
1469 | "line": 823
|
1470 | },
|
1471 | "parameters": [
|
1472 | {
|
1473 | "docs": {
|
1474 | "summary": "- scope in which this resource is defined."
|
1475 | },
|
1476 | "name": "scope",
|
1477 | "type": {
|
1478 | "fqn": "@aws-cdk/core.Construct"
|
1479 | }
|
1480 | },
|
1481 | {
|
1482 | "docs": {
|
1483 | "summary": "- scoped id of the resource."
|
1484 | },
|
1485 | "name": "id",
|
1486 | "type": {
|
1487 | "primitive": "string"
|
1488 | }
|
1489 | },
|
1490 | {
|
1491 | "docs": {
|
1492 | "summary": "- resource properties."
|
1493 | },
|
1494 | "name": "props",
|
1495 | "type": {
|
1496 | "fqn": "@aws-cdk/aws-logs.CfnMetricFilterProps"
|
1497 | }
|
1498 | }
|
1499 | ]
|
1500 | },
|
1501 | "interfaces": [
|
1502 | "@aws-cdk/core.IInspectable"
|
1503 | ],
|
1504 | "kind": "class",
|
1505 | "locationInModule": {
|
1506 | "filename": "lib/logs.generated.ts",
|
1507 | "line": 763
|
1508 | },
|
1509 | "methods": [
|
1510 | {
|
1511 | "docs": {
|
1512 | "stability": "external",
|
1513 | "summary": "Examines the CloudFormation resource and discloses attributes."
|
1514 | },
|
1515 | "locationInModule": {
|
1516 | "filename": "lib/logs.generated.ts",
|
1517 | "line": 841
|
1518 | },
|
1519 | "name": "inspect",
|
1520 | "overrides": "@aws-cdk/core.IInspectable",
|
1521 | "parameters": [
|
1522 | {
|
1523 | "docs": {
|
1524 | "summary": "- tree inspector to collect and process attributes."
|
1525 | },
|
1526 | "name": "inspector",
|
1527 | "type": {
|
1528 | "fqn": "@aws-cdk/core.TreeInspector"
|
1529 | }
|
1530 | }
|
1531 | ]
|
1532 | },
|
1533 | {
|
1534 | "docs": {
|
1535 | "stability": "external"
|
1536 | },
|
1537 | "locationInModule": {
|
1538 | "filename": "lib/logs.generated.ts",
|
1539 | "line": 855
|
1540 | },
|
1541 | "name": "renderProperties",
|
1542 | "overrides": "@aws-cdk/core.CfnResource",
|
1543 | "parameters": [
|
1544 | {
|
1545 | "name": "props",
|
1546 | "type": {
|
1547 | "collection": {
|
1548 | "elementtype": {
|
1549 | "primitive": "any"
|
1550 | },
|
1551 | "kind": "map"
|
1552 | }
|
1553 | }
|
1554 | }
|
1555 | ],
|
1556 | "protected": true,
|
1557 | "returns": {
|
1558 | "type": {
|
1559 | "collection": {
|
1560 | "elementtype": {
|
1561 | "primitive": "any"
|
1562 | },
|
1563 | "kind": "map"
|
1564 | }
|
1565 | }
|
1566 | }
|
1567 | }
|
1568 | ],
|
1569 | "name": "CfnMetricFilter",
|
1570 | "properties": [
|
1571 | {
|
1572 | "const": true,
|
1573 | "docs": {
|
1574 | "stability": "external",
|
1575 | "summary": "The CloudFormation resource type name for this resource class."
|
1576 | },
|
1577 | "immutable": true,
|
1578 | "locationInModule": {
|
1579 | "filename": "lib/logs.generated.ts",
|
1580 | "line": 767
|
1581 | },
|
1582 | "name": "CFN_RESOURCE_TYPE_NAME",
|
1583 | "static": true,
|
1584 | "type": {
|
1585 | "primitive": "string"
|
1586 | }
|
1587 | },
|
1588 | {
|
1589 | "docs": {
|
1590 | "stability": "external"
|
1591 | },
|
1592 | "immutable": true,
|
1593 | "locationInModule": {
|
1594 | "filename": "lib/logs.generated.ts",
|
1595 | "line": 846
|
1596 | },
|
1597 | "name": "cfnProperties",
|
1598 | "overrides": "@aws-cdk/core.CfnResource",
|
1599 | "protected": true,
|
1600 | "type": {
|
1601 | "collection": {
|
1602 | "elementtype": {
|
1603 | "primitive": "any"
|
1604 | },
|
1605 | "kind": "map"
|
1606 | }
|
1607 | }
|
1608 | },
|
1609 | {
|
1610 | "docs": {
|
1611 | "custom": {
|
1612 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-filterpattern"
|
1613 | },
|
1614 | "remarks": "For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html) .",
|
1615 | "stability": "external",
|
1616 | "summary": "A filter pattern for extracting metric data out of ingested log events."
|
1617 | },
|
1618 | "locationInModule": {
|
1619 | "filename": "lib/logs.generated.ts",
|
1620 | "line": 793
|
1621 | },
|
1622 | "name": "filterPattern",
|
1623 | "type": {
|
1624 | "primitive": "string"
|
1625 | }
|
1626 | },
|
1627 | {
|
1628 | "docs": {
|
1629 | "custom": {
|
1630 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-loggroupname"
|
1631 | },
|
1632 | "stability": "external",
|
1633 | "summary": "The name of an existing log group that you want to associate with this metric filter."
|
1634 | },
|
1635 | "locationInModule": {
|
1636 | "filename": "lib/logs.generated.ts",
|
1637 | "line": 800
|
1638 | },
|
1639 | "name": "logGroupName",
|
1640 | "type": {
|
1641 | "primitive": "string"
|
1642 | }
|
1643 | },
|
1644 | {
|
1645 | "docs": {
|
1646 | "custom": {
|
1647 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-metrictransformations"
|
1648 | },
|
1649 | "stability": "external",
|
1650 | "summary": "The metric transformations."
|
1651 | },
|
1652 | "locationInModule": {
|
1653 | "filename": "lib/logs.generated.ts",
|
1654 | "line": 807
|
1655 | },
|
1656 | "name": "metricTransformations",
|
1657 | "type": {
|
1658 | "union": {
|
1659 | "types": [
|
1660 | {
|
1661 | "fqn": "@aws-cdk/core.IResolvable"
|
1662 | },
|
1663 | {
|
1664 | "collection": {
|
1665 | "elementtype": {
|
1666 | "union": {
|
1667 | "types": [
|
1668 | {
|
1669 | "fqn": "@aws-cdk/core.IResolvable"
|
1670 | },
|
1671 | {
|
1672 | "fqn": "@aws-cdk/aws-logs.CfnMetricFilter.MetricTransformationProperty"
|
1673 | }
|
1674 | ]
|
1675 | }
|
1676 | },
|
1677 | "kind": "array"
|
1678 | }
|
1679 | }
|
1680 | ]
|
1681 | }
|
1682 | }
|
1683 | },
|
1684 | {
|
1685 | "docs": {
|
1686 | "custom": {
|
1687 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-filtername"
|
1688 | },
|
1689 | "stability": "external",
|
1690 | "summary": "The name of the metric filter."
|
1691 | },
|
1692 | "locationInModule": {
|
1693 | "filename": "lib/logs.generated.ts",
|
1694 | "line": 814
|
1695 | },
|
1696 | "name": "filterName",
|
1697 | "optional": true,
|
1698 | "type": {
|
1699 | "primitive": "string"
|
1700 | }
|
1701 | }
|
1702 | ],
|
1703 | "symbolId": "lib/logs.generated:CfnMetricFilter"
|
1704 | },
|
1705 | "@aws-cdk/aws-logs.CfnMetricFilter.DimensionProperty": {
|
1706 | "assembly": "@aws-cdk/aws-logs",
|
1707 | "datatype": true,
|
1708 | "docs": {
|
1709 | "custom": {
|
1710 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-dimension.html",
|
1711 | "exampleMetadata": "fixture=_generated"
|
1712 | },
|
1713 | "remarks": "Because dimensions are part of the unique identifier for a metric, whenever a unique dimension name/value pair is extracted from your logs, you are creating a new variation of that metric.\n\nFor more information about publishing dimensions with metrics created by metric filters, see [Publishing dimensions with metrics from values in JSON or space-delimited log events](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html#logs-metric-filters-dimensions) .\n\n> Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as `IPAddress` or `requestID` as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.\n>\n> To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.\n>\n> You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see [Creating a Billing Alarm to Monitor Your Estimated AWS Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html) .",
|
1714 | "stability": "external",
|
1715 | "summary": "Specifies the CloudWatch metric dimensions to publish with this metric.",
|
1716 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as logs from '@aws-cdk/aws-logs';\nconst dimensionProperty: logs.CfnMetricFilter.DimensionProperty = {\n key: 'key',\n value: 'value',\n};"
|
1717 | },
|
1718 | "fqn": "@aws-cdk/aws-logs.CfnMetricFilter.DimensionProperty",
|
1719 | "kind": "interface",
|
1720 | "locationInModule": {
|
1721 | "filename": "lib/logs.generated.ts",
|
1722 | "line": 879
|
1723 | },
|
1724 | "name": "DimensionProperty",
|
1725 | "namespace": "CfnMetricFilter",
|
1726 | "properties": [
|
1727 | {
|
1728 | "abstract": true,
|
1729 | "docs": {
|
1730 | "custom": {
|
1731 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-dimension.html#cfn-logs-metricfilter-dimension-key"
|
1732 | },
|
1733 | "remarks": "Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:).",
|
1734 | "stability": "external",
|
1735 | "summary": "The name for the CloudWatch metric dimension that the metric filter creates."
|
1736 | },
|
1737 | "immutable": true,
|
1738 | "locationInModule": {
|
1739 | "filename": "lib/logs.generated.ts",
|
1740 | "line": 887
|
1741 | },
|
1742 | "name": "key",
|
1743 | "type": {
|
1744 | "primitive": "string"
|
1745 | }
|
1746 | },
|
1747 | {
|
1748 | "abstract": true,
|
1749 | "docs": {
|
1750 | "custom": {
|
1751 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-dimension.html#cfn-logs-metricfilter-dimension-value"
|
1752 | },
|
1753 | "remarks": "This dimension will only be published for a metric if the value is found in the log event. For example, `$.eventType` for JSON log events, or `$server` for space-delimited log events.",
|
1754 | "stability": "external",
|
1755 | "summary": "The log event field that will contain the value for this dimension."
|
1756 | },
|
1757 | "immutable": true,
|
1758 | "locationInModule": {
|
1759 | "filename": "lib/logs.generated.ts",
|
1760 | "line": 893
|
1761 | },
|
1762 | "name": "value",
|
1763 | "type": {
|
1764 | "primitive": "string"
|
1765 | }
|
1766 | }
|
1767 | ],
|
1768 | "symbolId": "lib/logs.generated:CfnMetricFilter.DimensionProperty"
|
1769 | },
|
1770 | "@aws-cdk/aws-logs.CfnMetricFilter.MetricTransformationProperty": {
|
1771 | "assembly": "@aws-cdk/aws-logs",
|
1772 | "datatype": true,
|
1773 | "docs": {
|
1774 | "custom": {
|
1775 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html",
|
1776 | "exampleMetadata": "fixture=_generated"
|
1777 | },
|
1778 | "stability": "external",
|
1779 | "summary": "`MetricTransformation` is a property of the `AWS::Logs::MetricFilter` resource that describes how to transform log streams into a CloudWatch metric.",
|
1780 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as logs from '@aws-cdk/aws-logs';\nconst metricTransformationProperty: logs.CfnMetricFilter.MetricTransformationProperty = {\n metricName: 'metricName',\n metricNamespace: 'metricNamespace',\n metricValue: 'metricValue',\n\n // the properties below are optional\n defaultValue: 123,\n dimensions: [{\n key: 'key',\n value: 'value',\n }],\n unit: 'unit',\n};"
|
1781 | },
|
1782 | "fqn": "@aws-cdk/aws-logs.CfnMetricFilter.MetricTransformationProperty",
|
1783 | "kind": "interface",
|
1784 | "locationInModule": {
|
1785 | "filename": "lib/logs.generated.ts",
|
1786 | "line": 959
|
1787 | },
|
1788 | "name": "MetricTransformationProperty",
|
1789 | "namespace": "CfnMetricFilter",
|
1790 | "properties": [
|
1791 | {
|
1792 | "abstract": true,
|
1793 | "docs": {
|
1794 | "custom": {
|
1795 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-logs-metricfilter-metrictransformation-metricname"
|
1796 | },
|
1797 | "stability": "external",
|
1798 | "summary": "The name of the CloudWatch metric."
|
1799 | },
|
1800 | "immutable": true,
|
1801 | "locationInModule": {
|
1802 | "filename": "lib/logs.generated.ts",
|
1803 | "line": 983
|
1804 | },
|
1805 | "name": "metricName",
|
1806 | "type": {
|
1807 | "primitive": "string"
|
1808 | }
|
1809 | },
|
1810 | {
|
1811 | "abstract": true,
|
1812 | "docs": {
|
1813 | "custom": {
|
1814 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-logs-metricfilter-metrictransformation-metricnamespace"
|
1815 | },
|
1816 | "remarks": "Use namespaces to group together metrics that are similar. For more information, see [Namespaces](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace) .",
|
1817 | "stability": "external",
|
1818 | "summary": "A custom namespace to contain your metric in CloudWatch."
|
1819 | },
|
1820 | "immutable": true,
|
1821 | "locationInModule": {
|
1822 | "filename": "lib/logs.generated.ts",
|
1823 | "line": 989
|
1824 | },
|
1825 | "name": "metricNamespace",
|
1826 | "type": {
|
1827 | "primitive": "string"
|
1828 | }
|
1829 | },
|
1830 | {
|
1831 | "abstract": true,
|
1832 | "docs": {
|
1833 | "custom": {
|
1834 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-logs-metricfilter-metrictransformation-metricvalue"
|
1835 | },
|
1836 | "remarks": "For example, if you're counting the occurrences of a particular term like `Error` , specify 1 for the metric value. If you're counting the number of bytes transferred, reference the value that is in the log event by using $. followed by the name of the field that you specified in the filter pattern, such as `$.size` .",
|
1837 | "stability": "external",
|
1838 | "summary": "The value that is published to the CloudWatch metric."
|
1839 | },
|
1840 | "immutable": true,
|
1841 | "locationInModule": {
|
1842 | "filename": "lib/logs.generated.ts",
|
1843 | "line": 995
|
1844 | },
|
1845 | "name": "metricValue",
|
1846 | "type": {
|
1847 | "primitive": "string"
|
1848 | }
|
1849 | },
|
1850 | {
|
1851 | "abstract": true,
|
1852 | "docs": {
|
1853 | "custom": {
|
1854 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-logs-metricfilter-metrictransformation-defaultvalue"
|
1855 | },
|
1856 | "remarks": "This value can be null.",
|
1857 | "stability": "external",
|
1858 | "summary": "(Optional) The value to emit when a filter pattern does not match a log event."
|
1859 | },
|
1860 | "immutable": true,
|
1861 | "locationInModule": {
|
1862 | "filename": "lib/logs.generated.ts",
|
1863 | "line": 965
|
1864 | },
|
1865 | "name": "defaultValue",
|
1866 | "optional": true,
|
1867 | "type": {
|
1868 | "primitive": "number"
|
1869 | }
|
1870 | },
|
1871 | {
|
1872 | "abstract": true,
|
1873 | "docs": {
|
1874 | "custom": {
|
1875 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-logs-metricfilter-metrictransformation-dimensions"
|
1876 | },
|
1877 | "remarks": "> Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as `IPAddress` or `requestID` as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.\n>\n> CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.\n>\n> You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see [Creating a Billing Alarm to Monitor Your Estimated AWS Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html) .",
|
1878 | "stability": "external",
|
1879 | "summary": "The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions."
|
1880 | },
|
1881 | "immutable": true,
|
1882 | "locationInModule": {
|
1883 | "filename": "lib/logs.generated.ts",
|
1884 | "line": 977
|
1885 | },
|
1886 | "name": "dimensions",
|
1887 | "optional": true,
|
1888 | "type": {
|
1889 | "union": {
|
1890 | "types": [
|
1891 | {
|
1892 | "fqn": "@aws-cdk/core.IResolvable"
|
1893 | },
|
1894 | {
|
1895 | "collection": {
|
1896 | "elementtype": {
|
1897 | "union": {
|
1898 | "types": [
|
1899 | {
|
1900 | "fqn": "@aws-cdk/core.IResolvable"
|
1901 | },
|
1902 | {
|
1903 | "fqn": "@aws-cdk/aws-logs.CfnMetricFilter.DimensionProperty"
|
1904 | }
|
1905 | ]
|
1906 | }
|
1907 | },
|
1908 | "kind": "array"
|
1909 | }
|
1910 | }
|
1911 | ]
|
1912 | }
|
1913 | }
|
1914 | },
|
1915 | {
|
1916 | "abstract": true,
|
1917 | "docs": {
|
1918 | "custom": {
|
1919 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-logs-metricfilter-metrictransformation-unit"
|
1920 | },
|
1921 | "remarks": "If you omit this, the unit is set as `None` .",
|
1922 | "stability": "external",
|
1923 | "summary": "The unit to assign to the metric."
|
1924 | },
|
1925 | "immutable": true,
|
1926 | "locationInModule": {
|
1927 | "filename": "lib/logs.generated.ts",
|
1928 | "line": 1001
|
1929 | },
|
1930 | "name": "unit",
|
1931 | "optional": true,
|
1932 | "type": {
|
1933 | "primitive": "string"
|
1934 | }
|
1935 | }
|
1936 | ],
|
1937 | "symbolId": "lib/logs.generated:CfnMetricFilter.MetricTransformationProperty"
|
1938 | },
|
1939 | "@aws-cdk/aws-logs.CfnMetricFilterProps": {
|
1940 | "assembly": "@aws-cdk/aws-logs",
|
1941 | "datatype": true,
|
1942 | "docs": {
|
1943 | "custom": {
|
1944 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html",
|
1945 | "exampleMetadata": "fixture=_generated"
|
1946 | },
|
1947 | "stability": "external",
|
1948 | "summary": "Properties for defining a `CfnMetricFilter`.",
|
1949 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as logs from '@aws-cdk/aws-logs';\nconst cfnMetricFilterProps: logs.CfnMetricFilterProps = {\n filterPattern: 'filterPattern',\n logGroupName: 'logGroupName',\n metricTransformations: [{\n metricName: 'metricName',\n metricNamespace: 'metricNamespace',\n metricValue: 'metricValue',\n\n // the properties below are optional\n defaultValue: 123,\n dimensions: [{\n key: 'key',\n value: 'value',\n }],\n unit: 'unit',\n }],\n\n // the properties below are optional\n filterName: 'filterName',\n};"
|
1950 | },
|
1951 | "fqn": "@aws-cdk/aws-logs.CfnMetricFilterProps",
|
1952 | "kind": "interface",
|
1953 | "locationInModule": {
|
1954 | "filename": "lib/logs.generated.ts",
|
1955 | "line": 663
|
1956 | },
|
1957 | "name": "CfnMetricFilterProps",
|
1958 | "properties": [
|
1959 | {
|
1960 | "abstract": true,
|
1961 | "docs": {
|
1962 | "custom": {
|
1963 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-filterpattern"
|
1964 | },
|
1965 | "remarks": "For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html) .",
|
1966 | "stability": "external",
|
1967 | "summary": "A filter pattern for extracting metric data out of ingested log events."
|
1968 | },
|
1969 | "immutable": true,
|
1970 | "locationInModule": {
|
1971 | "filename": "lib/logs.generated.ts",
|
1972 | "line": 670
|
1973 | },
|
1974 | "name": "filterPattern",
|
1975 | "type": {
|
1976 | "primitive": "string"
|
1977 | }
|
1978 | },
|
1979 | {
|
1980 | "abstract": true,
|
1981 | "docs": {
|
1982 | "custom": {
|
1983 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-loggroupname"
|
1984 | },
|
1985 | "stability": "external",
|
1986 | "summary": "The name of an existing log group that you want to associate with this metric filter."
|
1987 | },
|
1988 | "immutable": true,
|
1989 | "locationInModule": {
|
1990 | "filename": "lib/logs.generated.ts",
|
1991 | "line": 677
|
1992 | },
|
1993 | "name": "logGroupName",
|
1994 | "type": {
|
1995 | "primitive": "string"
|
1996 | }
|
1997 | },
|
1998 | {
|
1999 | "abstract": true,
|
2000 | "docs": {
|
2001 | "custom": {
|
2002 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-metrictransformations"
|
2003 | },
|
2004 | "stability": "external",
|
2005 | "summary": "The metric transformations."
|
2006 | },
|
2007 | "immutable": true,
|
2008 | "locationInModule": {
|
2009 | "filename": "lib/logs.generated.ts",
|
2010 | "line": 684
|
2011 | },
|
2012 | "name": "metricTransformations",
|
2013 | "type": {
|
2014 | "union": {
|
2015 | "types": [
|
2016 | {
|
2017 | "fqn": "@aws-cdk/core.IResolvable"
|
2018 | },
|
2019 | {
|
2020 | "collection": {
|
2021 | "elementtype": {
|
2022 | "union": {
|
2023 | "types": [
|
2024 | {
|
2025 | "fqn": "@aws-cdk/core.IResolvable"
|
2026 | },
|
2027 | {
|
2028 | "fqn": "@aws-cdk/aws-logs.CfnMetricFilter.MetricTransformationProperty"
|
2029 | }
|
2030 | ]
|
2031 | }
|
2032 | },
|
2033 | "kind": "array"
|
2034 | }
|
2035 | }
|
2036 | ]
|
2037 | }
|
2038 | }
|
2039 | },
|
2040 | {
|
2041 | "abstract": true,
|
2042 | "docs": {
|
2043 | "custom": {
|
2044 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-filtername"
|
2045 | },
|
2046 | "stability": "external",
|
2047 | "summary": "The name of the metric filter."
|
2048 | },
|
2049 | "immutable": true,
|
2050 | "locationInModule": {
|
2051 | "filename": "lib/logs.generated.ts",
|
2052 | "line": 691
|
2053 | },
|
2054 | "name": "filterName",
|
2055 | "optional": true,
|
2056 | "type": {
|
2057 | "primitive": "string"
|
2058 | }
|
2059 | }
|
2060 | ],
|
2061 | "symbolId": "lib/logs.generated:CfnMetricFilterProps"
|
2062 | },
|
2063 | "@aws-cdk/aws-logs.CfnQueryDefinition": {
|
2064 | "assembly": "@aws-cdk/aws-logs",
|
2065 | "base": "@aws-cdk/core.CfnResource",
|
2066 | "docs": {
|
2067 | "custom": {
|
2068 | "cloudformationResource": "AWS::Logs::QueryDefinition",
|
2069 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html",
|
2070 | "exampleMetadata": "fixture=_generated"
|
2071 | },
|
2072 | "remarks": "Creates a query definition for CloudWatch Logs Insights. For more information, see [Analyzing Log Data with CloudWatch Logs Insights](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html) .",
|
2073 | "stability": "external",
|
2074 | "summary": "A CloudFormation `AWS::Logs::QueryDefinition`.",
|
2075 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as logs from '@aws-cdk/aws-logs';\nconst cfnQueryDefinition = new logs.CfnQueryDefinition(this, 'MyCfnQueryDefinition', {\n name: 'name',\n queryString: 'queryString',\n\n // the properties below are optional\n logGroupNames: ['logGroupNames'],\n});"
|
2076 | },
|
2077 | "fqn": "@aws-cdk/aws-logs.CfnQueryDefinition",
|
2078 | "initializer": {
|
2079 | "docs": {
|
2080 | "stability": "external",
|
2081 | "summary": "Create a new `AWS::Logs::QueryDefinition`."
|
2082 | },
|
2083 | "locationInModule": {
|
2084 | "filename": "lib/logs.generated.ts",
|
2085 | "line": 1225
|
2086 | },
|
2087 | "parameters": [
|
2088 | {
|
2089 | "docs": {
|
2090 | "summary": "- scope in which this resource is defined."
|
2091 | },
|
2092 | "name": "scope",
|
2093 | "type": {
|
2094 | "fqn": "@aws-cdk/core.Construct"
|
2095 | }
|
2096 | },
|
2097 | {
|
2098 | "docs": {
|
2099 | "summary": "- scoped id of the resource."
|
2100 | },
|
2101 | "name": "id",
|
2102 | "type": {
|
2103 | "primitive": "string"
|
2104 | }
|
2105 | },
|
2106 | {
|
2107 | "docs": {
|
2108 | "summary": "- resource properties."
|
2109 | },
|
2110 | "name": "props",
|
2111 | "type": {
|
2112 | "fqn": "@aws-cdk/aws-logs.CfnQueryDefinitionProps"
|
2113 | }
|
2114 | }
|
2115 | ]
|
2116 | },
|
2117 | "interfaces": [
|
2118 | "@aws-cdk/core.IInspectable"
|
2119 | ],
|
2120 | "kind": "class",
|
2121 | "locationInModule": {
|
2122 | "filename": "lib/logs.generated.ts",
|
2123 | "line": 1166
|
2124 | },
|
2125 | "methods": [
|
2126 | {
|
2127 | "docs": {
|
2128 | "stability": "external",
|
2129 | "summary": "Examines the CloudFormation resource and discloses attributes."
|
2130 | },
|
2131 | "locationInModule": {
|
2132 | "filename": "lib/logs.generated.ts",
|
2133 | "line": 1242
|
2134 | },
|
2135 | "name": "inspect",
|
2136 | "overrides": "@aws-cdk/core.IInspectable",
|
2137 | "parameters": [
|
2138 | {
|
2139 | "docs": {
|
2140 | "summary": "- tree inspector to collect and process attributes."
|
2141 | },
|
2142 | "name": "inspector",
|
2143 | "type": {
|
2144 | "fqn": "@aws-cdk/core.TreeInspector"
|
2145 | }
|
2146 | }
|
2147 | ]
|
2148 | },
|
2149 | {
|
2150 | "docs": {
|
2151 | "stability": "external"
|
2152 | },
|
2153 | "locationInModule": {
|
2154 | "filename": "lib/logs.generated.ts",
|
2155 | "line": 1255
|
2156 | },
|
2157 | "name": "renderProperties",
|
2158 | "overrides": "@aws-cdk/core.CfnResource",
|
2159 | "parameters": [
|
2160 | {
|
2161 | "name": "props",
|
2162 | "type": {
|
2163 | "collection": {
|
2164 | "elementtype": {
|
2165 | "primitive": "any"
|
2166 | },
|
2167 | "kind": "map"
|
2168 | }
|
2169 | }
|
2170 | }
|
2171 | ],
|
2172 | "protected": true,
|
2173 | "returns": {
|
2174 | "type": {
|
2175 | "collection": {
|
2176 | "elementtype": {
|
2177 | "primitive": "any"
|
2178 | },
|
2179 | "kind": "map"
|
2180 | }
|
2181 | }
|
2182 | }
|
2183 | }
|
2184 | ],
|
2185 | "name": "CfnQueryDefinition",
|
2186 | "properties": [
|
2187 | {
|
2188 | "const": true,
|
2189 | "docs": {
|
2190 | "stability": "external",
|
2191 | "summary": "The CloudFormation resource type name for this resource class."
|
2192 | },
|
2193 | "immutable": true,
|
2194 | "locationInModule": {
|
2195 | "filename": "lib/logs.generated.ts",
|
2196 | "line": 1170
|
2197 | },
|
2198 | "name": "CFN_RESOURCE_TYPE_NAME",
|
2199 | "static": true,
|
2200 | "type": {
|
2201 | "primitive": "string"
|
2202 | }
|
2203 | },
|
2204 | {
|
2205 | "docs": {
|
2206 | "custom": {
|
2207 | "cloudformationAttribute": "QueryDefinitionId"
|
2208 | },
|
2209 | "stability": "external",
|
2210 | "summary": "The ID of the query definition."
|
2211 | },
|
2212 | "immutable": true,
|
2213 | "locationInModule": {
|
2214 | "filename": "lib/logs.generated.ts",
|
2215 | "line": 1195
|
2216 | },
|
2217 | "name": "attrQueryDefinitionId",
|
2218 | "type": {
|
2219 | "primitive": "string"
|
2220 | }
|
2221 | },
|
2222 | {
|
2223 | "docs": {
|
2224 | "stability": "external"
|
2225 | },
|
2226 | "immutable": true,
|
2227 | "locationInModule": {
|
2228 | "filename": "lib/logs.generated.ts",
|
2229 | "line": 1247
|
2230 | },
|
2231 | "name": "cfnProperties",
|
2232 | "overrides": "@aws-cdk/core.CfnResource",
|
2233 | "protected": true,
|
2234 | "type": {
|
2235 | "collection": {
|
2236 | "elementtype": {
|
2237 | "primitive": "any"
|
2238 | },
|
2239 | "kind": "map"
|
2240 | }
|
2241 | }
|
2242 | },
|
2243 | {
|
2244 | "docs": {
|
2245 | "custom": {
|
2246 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-name"
|
2247 | },
|
2248 | "stability": "external",
|
2249 | "summary": "A name for the query definition."
|
2250 | },
|
2251 | "locationInModule": {
|
2252 | "filename": "lib/logs.generated.ts",
|
2253 | "line": 1202
|
2254 | },
|
2255 | "name": "name",
|
2256 | "type": {
|
2257 | "primitive": "string"
|
2258 | }
|
2259 | },
|
2260 | {
|
2261 | "docs": {
|
2262 | "custom": {
|
2263 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-querystring"
|
2264 | },
|
2265 | "remarks": "For more information, see [CloudWatch Logs Insights Query Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html) .",
|
2266 | "stability": "external",
|
2267 | "summary": "The query string to use for this query definition."
|
2268 | },
|
2269 | "locationInModule": {
|
2270 | "filename": "lib/logs.generated.ts",
|
2271 | "line": 1209
|
2272 | },
|
2273 | "name": "queryString",
|
2274 | "type": {
|
2275 | "primitive": "string"
|
2276 | }
|
2277 | },
|
2278 | {
|
2279 | "docs": {
|
2280 | "custom": {
|
2281 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-loggroupnames"
|
2282 | },
|
2283 | "stability": "external",
|
2284 | "summary": "Use this parameter if you want the query to query only certain log groups."
|
2285 | },
|
2286 | "locationInModule": {
|
2287 | "filename": "lib/logs.generated.ts",
|
2288 | "line": 1216
|
2289 | },
|
2290 | "name": "logGroupNames",
|
2291 | "optional": true,
|
2292 | "type": {
|
2293 | "collection": {
|
2294 | "elementtype": {
|
2295 | "primitive": "string"
|
2296 | },
|
2297 | "kind": "array"
|
2298 | }
|
2299 | }
|
2300 | }
|
2301 | ],
|
2302 | "symbolId": "lib/logs.generated:CfnQueryDefinition"
|
2303 | },
|
2304 | "@aws-cdk/aws-logs.CfnQueryDefinitionProps": {
|
2305 | "assembly": "@aws-cdk/aws-logs",
|
2306 | "datatype": true,
|
2307 | "docs": {
|
2308 | "custom": {
|
2309 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html",
|
2310 | "exampleMetadata": "fixture=_generated"
|
2311 | },
|
2312 | "stability": "external",
|
2313 | "summary": "Properties for defining a `CfnQueryDefinition`.",
|
2314 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as logs from '@aws-cdk/aws-logs';\nconst cfnQueryDefinitionProps: logs.CfnQueryDefinitionProps = {\n name: 'name',\n queryString: 'queryString',\n\n // the properties below are optional\n logGroupNames: ['logGroupNames'],\n};"
|
2315 | },
|
2316 | "fqn": "@aws-cdk/aws-logs.CfnQueryDefinitionProps",
|
2317 | "kind": "interface",
|
2318 | "locationInModule": {
|
2319 | "filename": "lib/logs.generated.ts",
|
2320 | "line": 1079
|
2321 | },
|
2322 | "name": "CfnQueryDefinitionProps",
|
2323 | "properties": [
|
2324 | {
|
2325 | "abstract": true,
|
2326 | "docs": {
|
2327 | "custom": {
|
2328 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-name"
|
2329 | },
|
2330 | "stability": "external",
|
2331 | "summary": "A name for the query definition."
|
2332 | },
|
2333 | "immutable": true,
|
2334 | "locationInModule": {
|
2335 | "filename": "lib/logs.generated.ts",
|
2336 | "line": 1086
|
2337 | },
|
2338 | "name": "name",
|
2339 | "type": {
|
2340 | "primitive": "string"
|
2341 | }
|
2342 | },
|
2343 | {
|
2344 | "abstract": true,
|
2345 | "docs": {
|
2346 | "custom": {
|
2347 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-querystring"
|
2348 | },
|
2349 | "remarks": "For more information, see [CloudWatch Logs Insights Query Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html) .",
|
2350 | "stability": "external",
|
2351 | "summary": "The query string to use for this query definition."
|
2352 | },
|
2353 | "immutable": true,
|
2354 | "locationInModule": {
|
2355 | "filename": "lib/logs.generated.ts",
|
2356 | "line": 1093
|
2357 | },
|
2358 | "name": "queryString",
|
2359 | "type": {
|
2360 | "primitive": "string"
|
2361 | }
|
2362 | },
|
2363 | {
|
2364 | "abstract": true,
|
2365 | "docs": {
|
2366 | "custom": {
|
2367 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-loggroupnames"
|
2368 | },
|
2369 | "stability": "external",
|
2370 | "summary": "Use this parameter if you want the query to query only certain log groups."
|
2371 | },
|
2372 | "immutable": true,
|
2373 | "locationInModule": {
|
2374 | "filename": "lib/logs.generated.ts",
|
2375 | "line": 1100
|
2376 | },
|
2377 | "name": "logGroupNames",
|
2378 | "optional": true,
|
2379 | "type": {
|
2380 | "collection": {
|
2381 | "elementtype": {
|
2382 | "primitive": "string"
|
2383 | },
|
2384 | "kind": "array"
|
2385 | }
|
2386 | }
|
2387 | }
|
2388 | ],
|
2389 | "symbolId": "lib/logs.generated:CfnQueryDefinitionProps"
|
2390 | },
|
2391 | "@aws-cdk/aws-logs.CfnResourcePolicy": {
|
2392 | "assembly": "@aws-cdk/aws-logs",
|
2393 | "base": "@aws-cdk/core.CfnResource",
|
2394 | "docs": {
|
2395 | "custom": {
|
2396 | "cloudformationResource": "AWS::Logs::ResourcePolicy",
|
2397 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-resourcepolicy.html",
|
2398 | "exampleMetadata": "fixture=_generated"
|
2399 | },
|
2400 | "remarks": "Creates or updates a resource policy that allows other AWS services to put log events to this account. An account can have up to 10 resource policies per AWS Region.",
|
2401 | "stability": "external",
|
2402 | "summary": "A CloudFormation `AWS::Logs::ResourcePolicy`.",
|
2403 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as logs from '@aws-cdk/aws-logs';\nconst cfnResourcePolicy = new logs.CfnResourcePolicy(this, 'MyCfnResourcePolicy', {\n policyDocument: 'policyDocument',\n policyName: 'policyName',\n});"
|
2404 | },
|
2405 | "fqn": "@aws-cdk/aws-logs.CfnResourcePolicy",
|
2406 | "initializer": {
|
2407 | "docs": {
|
2408 | "stability": "external",
|
2409 | "summary": "Create a new `AWS::Logs::ResourcePolicy`."
|
2410 | },
|
2411 | "locationInModule": {
|
2412 | "filename": "lib/logs.generated.ts",
|
2413 | "line": 1391
|
2414 | },
|
2415 | "parameters": [
|
2416 | {
|
2417 | "docs": {
|
2418 | "summary": "- scope in which this resource is defined."
|
2419 | },
|
2420 | "name": "scope",
|
2421 | "type": {
|
2422 | "fqn": "@aws-cdk/core.Construct"
|
2423 | }
|
2424 | },
|
2425 | {
|
2426 | "docs": {
|
2427 | "summary": "- scoped id of the resource."
|
2428 | },
|
2429 | "name": "id",
|
2430 | "type": {
|
2431 | "primitive": "string"
|
2432 | }
|
2433 | },
|
2434 | {
|
2435 | "docs": {
|
2436 | "summary": "- resource properties."
|
2437 | },
|
2438 | "name": "props",
|
2439 | "type": {
|
2440 | "fqn": "@aws-cdk/aws-logs.CfnResourcePolicyProps"
|
2441 | }
|
2442 | }
|
2443 | ]
|
2444 | },
|
2445 | "interfaces": [
|
2446 | "@aws-cdk/core.IInspectable"
|
2447 | ],
|
2448 | "kind": "class",
|
2449 | "locationInModule": {
|
2450 | "filename": "lib/logs.generated.ts",
|
2451 | "line": 1345
|
2452 | },
|
2453 | "methods": [
|
2454 | {
|
2455 | "docs": {
|
2456 | "stability": "external",
|
2457 | "summary": "Examines the CloudFormation resource and discloses attributes."
|
2458 | },
|
2459 | "locationInModule": {
|
2460 | "filename": "lib/logs.generated.ts",
|
2461 | "line": 1406
|
2462 | },
|
2463 | "name": "inspect",
|
2464 | "overrides": "@aws-cdk/core.IInspectable",
|
2465 | "parameters": [
|
2466 | {
|
2467 | "docs": {
|
2468 | "summary": "- tree inspector to collect and process attributes."
|
2469 | },
|
2470 | "name": "inspector",
|
2471 | "type": {
|
2472 | "fqn": "@aws-cdk/core.TreeInspector"
|
2473 | }
|
2474 | }
|
2475 | ]
|
2476 | },
|
2477 | {
|
2478 | "docs": {
|
2479 | "stability": "external"
|
2480 | },
|
2481 | "locationInModule": {
|
2482 | "filename": "lib/logs.generated.ts",
|
2483 | "line": 1418
|
2484 | },
|
2485 | "name": "renderProperties",
|
2486 | "overrides": "@aws-cdk/core.CfnResource",
|
2487 | "parameters": [
|
2488 | {
|
2489 | "name": "props",
|
2490 | "type": {
|
2491 | "collection": {
|
2492 | "elementtype": {
|
2493 | "primitive": "any"
|
2494 | },
|
2495 | "kind": "map"
|
2496 | }
|
2497 | }
|
2498 | }
|
2499 | ],
|
2500 | "protected": true,
|
2501 | "returns": {
|
2502 | "type": {
|
2503 | "collection": {
|
2504 | "elementtype": {
|
2505 | "primitive": "any"
|
2506 | },
|
2507 | "kind": "map"
|
2508 | }
|
2509 | }
|
2510 | }
|
2511 | }
|
2512 | ],
|
2513 | "name": "CfnResourcePolicy",
|
2514 | "properties": [
|
2515 | {
|
2516 | "const": true,
|
2517 | "docs": {
|
2518 | "stability": "external",
|
2519 | "summary": "The CloudFormation resource type name for this resource class."
|
2520 | },
|
2521 | "immutable": true,
|
2522 | "locationInModule": {
|
2523 | "filename": "lib/logs.generated.ts",
|
2524 | "line": 1349
|
2525 | },
|
2526 | "name": "CFN_RESOURCE_TYPE_NAME",
|
2527 | "static": true,
|
2528 | "type": {
|
2529 | "primitive": "string"
|
2530 | }
|
2531 | },
|
2532 | {
|
2533 | "docs": {
|
2534 | "stability": "external"
|
2535 | },
|
2536 | "immutable": true,
|
2537 | "locationInModule": {
|
2538 | "filename": "lib/logs.generated.ts",
|
2539 | "line": 1411
|
2540 | },
|
2541 | "name": "cfnProperties",
|
2542 | "overrides": "@aws-cdk/core.CfnResource",
|
2543 | "protected": true,
|
2544 | "type": {
|
2545 | "collection": {
|
2546 | "elementtype": {
|
2547 | "primitive": "any"
|
2548 | },
|
2549 | "kind": "map"
|
2550 | }
|
2551 | }
|
2552 | },
|
2553 | {
|
2554 | "docs": {
|
2555 | "custom": {
|
2556 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-resourcepolicy.html#cfn-logs-resourcepolicy-policydocument"
|
2557 | },
|
2558 | "remarks": "It must be formatted in JSON, and you must use backslashes to escape characters that need to be escaped in JSON strings, such as double quote marks.",
|
2559 | "stability": "external",
|
2560 | "summary": "The details of the policy."
|
2561 | },
|
2562 | "locationInModule": {
|
2563 | "filename": "lib/logs.generated.ts",
|
2564 | "line": 1375
|
2565 | },
|
2566 | "name": "policyDocument",
|
2567 | "type": {
|
2568 | "primitive": "string"
|
2569 | }
|
2570 | },
|
2571 | {
|
2572 | "docs": {
|
2573 | "custom": {
|
2574 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-resourcepolicy.html#cfn-logs-resourcepolicy-policyname"
|
2575 | },
|
2576 | "stability": "external",
|
2577 | "summary": "The name of the resource policy."
|
2578 | },
|
2579 | "locationInModule": {
|
2580 | "filename": "lib/logs.generated.ts",
|
2581 | "line": 1382
|
2582 | },
|
2583 | "name": "policyName",
|
2584 | "type": {
|
2585 | "primitive": "string"
|
2586 | }
|
2587 | }
|
2588 | ],
|
2589 | "symbolId": "lib/logs.generated:CfnResourcePolicy"
|
2590 | },
|
2591 | "@aws-cdk/aws-logs.CfnResourcePolicyProps": {
|
2592 | "assembly": "@aws-cdk/aws-logs",
|
2593 | "datatype": true,
|
2594 | "docs": {
|
2595 | "custom": {
|
2596 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-resourcepolicy.html",
|
2597 | "exampleMetadata": "fixture=_generated"
|
2598 | },
|
2599 | "stability": "external",
|
2600 | "summary": "Properties for defining a `CfnResourcePolicy`.",
|
2601 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as logs from '@aws-cdk/aws-logs';\nconst cfnResourcePolicyProps: logs.CfnResourcePolicyProps = {\n policyDocument: 'policyDocument',\n policyName: 'policyName',\n};"
|
2602 | },
|
2603 | "fqn": "@aws-cdk/aws-logs.CfnResourcePolicyProps",
|
2604 | "kind": "interface",
|
2605 | "locationInModule": {
|
2606 | "filename": "lib/logs.generated.ts",
|
2607 | "line": 1268
|
2608 | },
|
2609 | "name": "CfnResourcePolicyProps",
|
2610 | "properties": [
|
2611 | {
|
2612 | "abstract": true,
|
2613 | "docs": {
|
2614 | "custom": {
|
2615 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-resourcepolicy.html#cfn-logs-resourcepolicy-policydocument"
|
2616 | },
|
2617 | "remarks": "It must be formatted in JSON, and you must use backslashes to escape characters that need to be escaped in JSON strings, such as double quote marks.",
|
2618 | "stability": "external",
|
2619 | "summary": "The details of the policy."
|
2620 | },
|
2621 | "immutable": true,
|
2622 | "locationInModule": {
|
2623 | "filename": "lib/logs.generated.ts",
|
2624 | "line": 1275
|
2625 | },
|
2626 | "name": "policyDocument",
|
2627 | "type": {
|
2628 | "primitive": "string"
|
2629 | }
|
2630 | },
|
2631 | {
|
2632 | "abstract": true,
|
2633 | "docs": {
|
2634 | "custom": {
|
2635 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-resourcepolicy.html#cfn-logs-resourcepolicy-policyname"
|
2636 | },
|
2637 | "stability": "external",
|
2638 | "summary": "The name of the resource policy."
|
2639 | },
|
2640 | "immutable": true,
|
2641 | "locationInModule": {
|
2642 | "filename": "lib/logs.generated.ts",
|
2643 | "line": 1282
|
2644 | },
|
2645 | "name": "policyName",
|
2646 | "type": {
|
2647 | "primitive": "string"
|
2648 | }
|
2649 | }
|
2650 | ],
|
2651 | "symbolId": "lib/logs.generated:CfnResourcePolicyProps"
|
2652 | },
|
2653 | "@aws-cdk/aws-logs.CfnSubscriptionFilter": {
|
2654 | "assembly": "@aws-cdk/aws-logs",
|
2655 | "base": "@aws-cdk/core.CfnResource",
|
2656 | "docs": {
|
2657 | "custom": {
|
2658 | "cloudformationResource": "AWS::Logs::SubscriptionFilter",
|
2659 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html",
|
2660 | "exampleMetadata": "fixture=_generated"
|
2661 | },
|
2662 | "remarks": "The `AWS::Logs::SubscriptionFilter` resource specifies a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events and have them delivered to a specific destination. Currently, the supported destinations are:\n\n- An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.\n- A logical destination that belongs to a different account, for cross-account delivery.\n- An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.\n- An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery.\n\nThere can be as many as two subscription filters associated with a log group.",
|
2663 | "stability": "external",
|
2664 | "summary": "A CloudFormation `AWS::Logs::SubscriptionFilter`.",
|
2665 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as logs from '@aws-cdk/aws-logs';\nconst cfnSubscriptionFilter = new logs.CfnSubscriptionFilter(this, 'MyCfnSubscriptionFilter', {\n destinationArn: 'destinationArn',\n filterPattern: 'filterPattern',\n logGroupName: 'logGroupName',\n\n // the properties below are optional\n distribution: 'distribution',\n filterName: 'filterName',\n roleArn: 'roleArn',\n});"
|
2666 | },
|
2667 | "fqn": "@aws-cdk/aws-logs.CfnSubscriptionFilter",
|
2668 | "initializer": {
|
2669 | "docs": {
|
2670 | "stability": "external",
|
2671 | "summary": "Create a new `AWS::Logs::SubscriptionFilter`."
|
2672 | },
|
2673 | "locationInModule": {
|
2674 | "filename": "lib/logs.generated.ts",
|
2675 | "line": 1630
|
2676 | },
|
2677 | "parameters": [
|
2678 | {
|
2679 | "docs": {
|
2680 | "summary": "- scope in which this resource is defined."
|
2681 | },
|
2682 | "name": "scope",
|
2683 | "type": {
|
2684 | "fqn": "@aws-cdk/core.Construct"
|
2685 | }
|
2686 | },
|
2687 | {
|
2688 | "docs": {
|
2689 | "summary": "- scoped id of the resource."
|
2690 | },
|
2691 | "name": "id",
|
2692 | "type": {
|
2693 | "primitive": "string"
|
2694 | }
|
2695 | },
|
2696 | {
|
2697 | "docs": {
|
2698 | "summary": "- resource properties."
|
2699 | },
|
2700 | "name": "props",
|
2701 | "type": {
|
2702 | "fqn": "@aws-cdk/aws-logs.CfnSubscriptionFilterProps"
|
2703 | }
|
2704 | }
|
2705 | ]
|
2706 | },
|
2707 | "interfaces": [
|
2708 | "@aws-cdk/core.IInspectable"
|
2709 | ],
|
2710 | "kind": "class",
|
2711 | "locationInModule": {
|
2712 | "filename": "lib/logs.generated.ts",
|
2713 | "line": 1556
|
2714 | },
|
2715 | "methods": [
|
2716 | {
|
2717 | "docs": {
|
2718 | "stability": "external",
|
2719 | "summary": "Examines the CloudFormation resource and discloses attributes."
|
2720 | },
|
2721 | "locationInModule": {
|
2722 | "filename": "lib/logs.generated.ts",
|
2723 | "line": 1650
|
2724 | },
|
2725 | "name": "inspect",
|
2726 | "overrides": "@aws-cdk/core.IInspectable",
|
2727 | "parameters": [
|
2728 | {
|
2729 | "docs": {
|
2730 | "summary": "- tree inspector to collect and process attributes."
|
2731 | },
|
2732 | "name": "inspector",
|
2733 | "type": {
|
2734 | "fqn": "@aws-cdk/core.TreeInspector"
|
2735 | }
|
2736 | }
|
2737 | ]
|
2738 | },
|
2739 | {
|
2740 | "docs": {
|
2741 | "stability": "external"
|
2742 | },
|
2743 | "locationInModule": {
|
2744 | "filename": "lib/logs.generated.ts",
|
2745 | "line": 1666
|
2746 | },
|
2747 | "name": "renderProperties",
|
2748 | "overrides": "@aws-cdk/core.CfnResource",
|
2749 | "parameters": [
|
2750 | {
|
2751 | "name": "props",
|
2752 | "type": {
|
2753 | "collection": {
|
2754 | "elementtype": {
|
2755 | "primitive": "any"
|
2756 | },
|
2757 | "kind": "map"
|
2758 | }
|
2759 | }
|
2760 | }
|
2761 | ],
|
2762 | "protected": true,
|
2763 | "returns": {
|
2764 | "type": {
|
2765 | "collection": {
|
2766 | "elementtype": {
|
2767 | "primitive": "any"
|
2768 | },
|
2769 | "kind": "map"
|
2770 | }
|
2771 | }
|
2772 | }
|
2773 | }
|
2774 | ],
|
2775 | "name": "CfnSubscriptionFilter",
|
2776 | "properties": [
|
2777 | {
|
2778 | "const": true,
|
2779 | "docs": {
|
2780 | "stability": "external",
|
2781 | "summary": "The CloudFormation resource type name for this resource class."
|
2782 | },
|
2783 | "immutable": true,
|
2784 | "locationInModule": {
|
2785 | "filename": "lib/logs.generated.ts",
|
2786 | "line": 1560
|
2787 | },
|
2788 | "name": "CFN_RESOURCE_TYPE_NAME",
|
2789 | "static": true,
|
2790 | "type": {
|
2791 | "primitive": "string"
|
2792 | }
|
2793 | },
|
2794 | {
|
2795 | "docs": {
|
2796 | "stability": "external"
|
2797 | },
|
2798 | "immutable": true,
|
2799 | "locationInModule": {
|
2800 | "filename": "lib/logs.generated.ts",
|
2801 | "line": 1655
|
2802 | },
|
2803 | "name": "cfnProperties",
|
2804 | "overrides": "@aws-cdk/core.CfnResource",
|
2805 | "protected": true,
|
2806 | "type": {
|
2807 | "collection": {
|
2808 | "elementtype": {
|
2809 | "primitive": "any"
|
2810 | },
|
2811 | "kind": "map"
|
2812 | }
|
2813 | }
|
2814 | },
|
2815 | {
|
2816 | "docs": {
|
2817 | "custom": {
|
2818 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-destinationarn"
|
2819 | },
|
2820 | "stability": "external",
|
2821 | "summary": "The Amazon Resource Name (ARN) of the destination."
|
2822 | },
|
2823 | "locationInModule": {
|
2824 | "filename": "lib/logs.generated.ts",
|
2825 | "line": 1586
|
2826 | },
|
2827 | "name": "destinationArn",
|
2828 | "type": {
|
2829 | "primitive": "string"
|
2830 | }
|
2831 | },
|
2832 | {
|
2833 | "docs": {
|
2834 | "custom": {
|
2835 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-filterpattern"
|
2836 | },
|
2837 | "remarks": "For more information about the filter pattern syntax, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html) .",
|
2838 | "stability": "external",
|
2839 | "summary": "The filtering expressions that restrict what gets delivered to the destination AWS resource."
|
2840 | },
|
2841 | "locationInModule": {
|
2842 | "filename": "lib/logs.generated.ts",
|
2843 | "line": 1593
|
2844 | },
|
2845 | "name": "filterPattern",
|
2846 | "type": {
|
2847 | "primitive": "string"
|
2848 | }
|
2849 | },
|
2850 | {
|
2851 | "docs": {
|
2852 | "custom": {
|
2853 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-loggroupname"
|
2854 | },
|
2855 | "remarks": "All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.",
|
2856 | "stability": "external",
|
2857 | "summary": "The log group to associate with the subscription filter."
|
2858 | },
|
2859 | "locationInModule": {
|
2860 | "filename": "lib/logs.generated.ts",
|
2861 | "line": 1600
|
2862 | },
|
2863 | "name": "logGroupName",
|
2864 | "type": {
|
2865 | "primitive": "string"
|
2866 | }
|
2867 | },
|
2868 | {
|
2869 | "docs": {
|
2870 | "custom": {
|
2871 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-distribution"
|
2872 | },
|
2873 | "stability": "external",
|
2874 | "summary": "`AWS::Logs::SubscriptionFilter.Distribution`."
|
2875 | },
|
2876 | "locationInModule": {
|
2877 | "filename": "lib/logs.generated.ts",
|
2878 | "line": 1607
|
2879 | },
|
2880 | "name": "distribution",
|
2881 | "optional": true,
|
2882 | "type": {
|
2883 | "primitive": "string"
|
2884 | }
|
2885 | },
|
2886 | {
|
2887 | "docs": {
|
2888 | "custom": {
|
2889 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-filtername"
|
2890 | },
|
2891 | "stability": "external",
|
2892 | "summary": "The name of the subscription filter."
|
2893 | },
|
2894 | "locationInModule": {
|
2895 | "filename": "lib/logs.generated.ts",
|
2896 | "line": 1614
|
2897 | },
|
2898 | "name": "filterName",
|
2899 | "optional": true,
|
2900 | "type": {
|
2901 | "primitive": "string"
|
2902 | }
|
2903 | },
|
2904 | {
|
2905 | "docs": {
|
2906 | "custom": {
|
2907 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-rolearn"
|
2908 | },
|
2909 | "remarks": "You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.",
|
2910 | "stability": "external",
|
2911 | "summary": "The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream."
|
2912 | },
|
2913 | "locationInModule": {
|
2914 | "filename": "lib/logs.generated.ts",
|
2915 | "line": 1621
|
2916 | },
|
2917 | "name": "roleArn",
|
2918 | "optional": true,
|
2919 | "type": {
|
2920 | "primitive": "string"
|
2921 | }
|
2922 | }
|
2923 | ],
|
2924 | "symbolId": "lib/logs.generated:CfnSubscriptionFilter"
|
2925 | },
|
2926 | "@aws-cdk/aws-logs.CfnSubscriptionFilterProps": {
|
2927 | "assembly": "@aws-cdk/aws-logs",
|
2928 | "datatype": true,
|
2929 | "docs": {
|
2930 | "custom": {
|
2931 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html",
|
2932 | "exampleMetadata": "fixture=_generated"
|
2933 | },
|
2934 | "stability": "external",
|
2935 | "summary": "Properties for defining a `CfnSubscriptionFilter`.",
|
2936 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as logs from '@aws-cdk/aws-logs';\nconst cfnSubscriptionFilterProps: logs.CfnSubscriptionFilterProps = {\n destinationArn: 'destinationArn',\n filterPattern: 'filterPattern',\n logGroupName: 'logGroupName',\n\n // the properties below are optional\n distribution: 'distribution',\n filterName: 'filterName',\n roleArn: 'roleArn',\n};"
|
2937 | },
|
2938 | "fqn": "@aws-cdk/aws-logs.CfnSubscriptionFilterProps",
|
2939 | "kind": "interface",
|
2940 | "locationInModule": {
|
2941 | "filename": "lib/logs.generated.ts",
|
2942 | "line": 1431
|
2943 | },
|
2944 | "name": "CfnSubscriptionFilterProps",
|
2945 | "properties": [
|
2946 | {
|
2947 | "abstract": true,
|
2948 | "docs": {
|
2949 | "custom": {
|
2950 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-destinationarn"
|
2951 | },
|
2952 | "stability": "external",
|
2953 | "summary": "The Amazon Resource Name (ARN) of the destination."
|
2954 | },
|
2955 | "immutable": true,
|
2956 | "locationInModule": {
|
2957 | "filename": "lib/logs.generated.ts",
|
2958 | "line": 1438
|
2959 | },
|
2960 | "name": "destinationArn",
|
2961 | "type": {
|
2962 | "primitive": "string"
|
2963 | }
|
2964 | },
|
2965 | {
|
2966 | "abstract": true,
|
2967 | "docs": {
|
2968 | "custom": {
|
2969 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-filterpattern"
|
2970 | },
|
2971 | "remarks": "For more information about the filter pattern syntax, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html) .",
|
2972 | "stability": "external",
|
2973 | "summary": "The filtering expressions that restrict what gets delivered to the destination AWS resource."
|
2974 | },
|
2975 | "immutable": true,
|
2976 | "locationInModule": {
|
2977 | "filename": "lib/logs.generated.ts",
|
2978 | "line": 1445
|
2979 | },
|
2980 | "name": "filterPattern",
|
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-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-loggroupname"
|
2990 | },
|
2991 | "remarks": "All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.",
|
2992 | "stability": "external",
|
2993 | "summary": "The log group to associate with the subscription filter."
|
2994 | },
|
2995 | "immutable": true,
|
2996 | "locationInModule": {
|
2997 | "filename": "lib/logs.generated.ts",
|
2998 | "line": 1452
|
2999 | },
|
3000 | "name": "logGroupName",
|
3001 | "type": {
|
3002 | "primitive": "string"
|
3003 | }
|
3004 | },
|
3005 | {
|
3006 | "abstract": true,
|
3007 | "docs": {
|
3008 | "custom": {
|
3009 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-distribution"
|
3010 | },
|
3011 | "stability": "external",
|
3012 | "summary": "`AWS::Logs::SubscriptionFilter.Distribution`."
|
3013 | },
|
3014 | "immutable": true,
|
3015 | "locationInModule": {
|
3016 | "filename": "lib/logs.generated.ts",
|
3017 | "line": 1459
|
3018 | },
|
3019 | "name": "distribution",
|
3020 | "optional": true,
|
3021 | "type": {
|
3022 | "primitive": "string"
|
3023 | }
|
3024 | },
|
3025 | {
|
3026 | "abstract": true,
|
3027 | "docs": {
|
3028 | "custom": {
|
3029 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-filtername"
|
3030 | },
|
3031 | "stability": "external",
|
3032 | "summary": "The name of the subscription filter."
|
3033 | },
|
3034 | "immutable": true,
|
3035 | "locationInModule": {
|
3036 | "filename": "lib/logs.generated.ts",
|
3037 | "line": 1466
|
3038 | },
|
3039 | "name": "filterName",
|
3040 | "optional": true,
|
3041 | "type": {
|
3042 | "primitive": "string"
|
3043 | }
|
3044 | },
|
3045 | {
|
3046 | "abstract": true,
|
3047 | "docs": {
|
3048 | "custom": {
|
3049 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-rolearn"
|
3050 | },
|
3051 | "remarks": "You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.",
|
3052 | "stability": "external",
|
3053 | "summary": "The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream."
|
3054 | },
|
3055 | "immutable": true,
|
3056 | "locationInModule": {
|
3057 | "filename": "lib/logs.generated.ts",
|
3058 | "line": 1473
|
3059 | },
|
3060 | "name": "roleArn",
|
3061 | "optional": true,
|
3062 | "type": {
|
3063 | "primitive": "string"
|
3064 | }
|
3065 | }
|
3066 | ],
|
3067 | "symbolId": "lib/logs.generated:CfnSubscriptionFilterProps"
|
3068 | },
|
3069 | "@aws-cdk/aws-logs.ColumnRestriction": {
|
3070 | "assembly": "@aws-cdk/aws-logs",
|
3071 | "datatype": true,
|
3072 | "docs": {
|
3073 | "stability": "stable",
|
3074 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as logs from '@aws-cdk/aws-logs';\nconst columnRestriction: logs.ColumnRestriction = {\n comparison: 'comparison',\n\n // the properties below are optional\n numberValue: 123,\n stringValue: 'stringValue',\n};",
|
3075 | "custom": {
|
3076 | "exampleMetadata": "fixture=_generated"
|
3077 | }
|
3078 | },
|
3079 | "fqn": "@aws-cdk/aws-logs.ColumnRestriction",
|
3080 | "kind": "interface",
|
3081 | "locationInModule": {
|
3082 | "filename": "lib/pattern.ts",
|
3083 | "line": 369
|
3084 | },
|
3085 | "name": "ColumnRestriction",
|
3086 | "properties": [
|
3087 | {
|
3088 | "abstract": true,
|
3089 | "docs": {
|
3090 | "stability": "stable",
|
3091 | "summary": "Comparison operator to use."
|
3092 | },
|
3093 | "immutable": true,
|
3094 | "locationInModule": {
|
3095 | "filename": "lib/pattern.ts",
|
3096 | "line": 373
|
3097 | },
|
3098 | "name": "comparison",
|
3099 | "type": {
|
3100 | "primitive": "string"
|
3101 | }
|
3102 | },
|
3103 | {
|
3104 | "abstract": true,
|
3105 | "docs": {
|
3106 | "remarks": "Exactly one of 'stringValue' and 'numberValue' must be set.",
|
3107 | "stability": "stable",
|
3108 | "summary": "Number value to compare to."
|
3109 | },
|
3110 | "immutable": true,
|
3111 | "locationInModule": {
|
3112 | "filename": "lib/pattern.ts",
|
3113 | "line": 387
|
3114 | },
|
3115 | "name": "numberValue",
|
3116 | "optional": true,
|
3117 | "type": {
|
3118 | "primitive": "number"
|
3119 | }
|
3120 | },
|
3121 | {
|
3122 | "abstract": true,
|
3123 | "docs": {
|
3124 | "remarks": "Exactly one of 'stringValue' and 'numberValue' must be set.",
|
3125 | "stability": "stable",
|
3126 | "summary": "String value to compare to."
|
3127 | },
|
3128 | "immutable": true,
|
3129 | "locationInModule": {
|
3130 | "filename": "lib/pattern.ts",
|
3131 | "line": 380
|
3132 | },
|
3133 | "name": "stringValue",
|
3134 | "optional": true,
|
3135 | "type": {
|
3136 | "primitive": "string"
|
3137 | }
|
3138 | }
|
3139 | ],
|
3140 | "symbolId": "lib/pattern:ColumnRestriction"
|
3141 | },
|
3142 | "@aws-cdk/aws-logs.CrossAccountDestination": {
|
3143 | "assembly": "@aws-cdk/aws-logs",
|
3144 | "base": "@aws-cdk/core.Resource",
|
3145 | "docs": {
|
3146 | "custom": {
|
3147 | "resource": "AWS::Logs::Destination",
|
3148 | "exampleMetadata": "fixture=_generated"
|
3149 | },
|
3150 | "remarks": "CrossAccountDestinations are used to subscribe a Kinesis stream in a\ndifferent account to a CloudWatch Subscription.\n\nConsumers will hardly ever need to use this class. Instead, directly\nsubscribe a Kinesis stream using the integration class in the\n`@aws-cdk/aws-logs-destinations` package; if necessary, a\n`CrossAccountDestination` will be created automatically.",
|
3151 | "stability": "stable",
|
3152 | "summary": "A new CloudWatch Logs Destination for use in cross-account scenarios.",
|
3153 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as logs from '@aws-cdk/aws-logs';\n\ndeclare const role: iam.Role;\nconst crossAccountDestination = new logs.CrossAccountDestination(this, 'MyCrossAccountDestination', {\n role: role,\n targetArn: 'targetArn',\n\n // the properties below are optional\n destinationName: 'destinationName',\n});"
|
3154 | },
|
3155 | "fqn": "@aws-cdk/aws-logs.CrossAccountDestination",
|
3156 | "initializer": {
|
3157 | "docs": {
|
3158 | "stability": "stable"
|
3159 | },
|
3160 | "locationInModule": {
|
3161 | "filename": "lib/cross-account-destination.ts",
|
3162 | "line": 76
|
3163 | },
|
3164 | "parameters": [
|
3165 | {
|
3166 | "name": "scope",
|
3167 | "type": {
|
3168 | "fqn": "constructs.Construct"
|
3169 | }
|
3170 | },
|
3171 | {
|
3172 | "name": "id",
|
3173 | "type": {
|
3174 | "primitive": "string"
|
3175 | }
|
3176 | },
|
3177 | {
|
3178 | "name": "props",
|
3179 | "type": {
|
3180 | "fqn": "@aws-cdk/aws-logs.CrossAccountDestinationProps"
|
3181 | }
|
3182 | }
|
3183 | ]
|
3184 | },
|
3185 | "interfaces": [
|
3186 | "@aws-cdk/aws-logs.ILogSubscriptionDestination"
|
3187 | ],
|
3188 | "kind": "class",
|
3189 | "locationInModule": {
|
3190 | "filename": "lib/cross-account-destination.ts",
|
3191 | "line": 53
|
3192 | },
|
3193 | "methods": [
|
3194 | {
|
3195 | "docs": {
|
3196 | "stability": "stable"
|
3197 | },
|
3198 | "locationInModule": {
|
3199 | "filename": "lib/cross-account-destination.ts",
|
3200 | "line": 100
|
3201 | },
|
3202 | "name": "addToPolicy",
|
3203 | "parameters": [
|
3204 | {
|
3205 | "name": "statement",
|
3206 | "type": {
|
3207 | "fqn": "@aws-cdk/aws-iam.PolicyStatement"
|
3208 | }
|
3209 | }
|
3210 | ]
|
3211 | },
|
3212 | {
|
3213 | "docs": {
|
3214 | "remarks": "If necessary, the destination can use the properties of the SubscriptionFilter\nobject itself to configure its permissions to allow the subscription to write\nto it.\n\nThe destination may reconfigure its own permissions in response to this\nfunction call.",
|
3215 | "stability": "stable",
|
3216 | "summary": "Return the properties required to send subscription events to this destination."
|
3217 | },
|
3218 | "locationInModule": {
|
3219 | "filename": "lib/cross-account-destination.ts",
|
3220 | "line": 104
|
3221 | },
|
3222 | "name": "bind",
|
3223 | "overrides": "@aws-cdk/aws-logs.ILogSubscriptionDestination",
|
3224 | "parameters": [
|
3225 | {
|
3226 | "name": "_scope",
|
3227 | "type": {
|
3228 | "fqn": "@aws-cdk/core.Construct"
|
3229 | }
|
3230 | },
|
3231 | {
|
3232 | "name": "_sourceLogGroup",
|
3233 | "type": {
|
3234 | "fqn": "@aws-cdk/aws-logs.ILogGroup"
|
3235 | }
|
3236 | }
|
3237 | ],
|
3238 | "returns": {
|
3239 | "type": {
|
3240 | "fqn": "@aws-cdk/aws-logs.LogSubscriptionDestinationConfig"
|
3241 | }
|
3242 | }
|
3243 | }
|
3244 | ],
|
3245 | "name": "CrossAccountDestination",
|
3246 | "properties": [
|
3247 | {
|
3248 | "docs": {
|
3249 | "custom": {
|
3250 | "attribute": "true"
|
3251 | },
|
3252 | "stability": "stable",
|
3253 | "summary": "The ARN of this CrossAccountDestination object."
|
3254 | },
|
3255 | "immutable": true,
|
3256 | "locationInModule": {
|
3257 | "filename": "lib/cross-account-destination.ts",
|
3258 | "line": 69
|
3259 | },
|
3260 | "name": "destinationArn",
|
3261 | "type": {
|
3262 | "primitive": "string"
|
3263 | }
|
3264 | },
|
3265 | {
|
3266 | "docs": {
|
3267 | "custom": {
|
3268 | "attribute": "true"
|
3269 | },
|
3270 | "stability": "stable",
|
3271 | "summary": "The name of this CrossAccountDestination object."
|
3272 | },
|
3273 | "immutable": true,
|
3274 | "locationInModule": {
|
3275 | "filename": "lib/cross-account-destination.ts",
|
3276 | "line": 63
|
3277 | },
|
3278 | "name": "destinationName",
|
3279 | "type": {
|
3280 | "primitive": "string"
|
3281 | }
|
3282 | },
|
3283 | {
|
3284 | "docs": {
|
3285 | "stability": "stable",
|
3286 | "summary": "Policy object of this CrossAccountDestination object."
|
3287 | },
|
3288 | "immutable": true,
|
3289 | "locationInModule": {
|
3290 | "filename": "lib/cross-account-destination.ts",
|
3291 | "line": 57
|
3292 | },
|
3293 | "name": "policyDocument",
|
3294 | "type": {
|
3295 | "fqn": "@aws-cdk/aws-iam.PolicyDocument"
|
3296 | }
|
3297 | }
|
3298 | ],
|
3299 | "symbolId": "lib/cross-account-destination:CrossAccountDestination"
|
3300 | },
|
3301 | "@aws-cdk/aws-logs.CrossAccountDestinationProps": {
|
3302 | "assembly": "@aws-cdk/aws-logs",
|
3303 | "datatype": true,
|
3304 | "docs": {
|
3305 | "stability": "stable",
|
3306 | "summary": "Properties for a CrossAccountDestination.",
|
3307 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as logs from '@aws-cdk/aws-logs';\n\ndeclare const role: iam.Role;\nconst crossAccountDestinationProps: logs.CrossAccountDestinationProps = {\n role: role,\n targetArn: 'targetArn',\n\n // the properties below are optional\n destinationName: 'destinationName',\n};",
|
3308 | "custom": {
|
3309 | "exampleMetadata": "fixture=_generated"
|
3310 | }
|
3311 | },
|
3312 | "fqn": "@aws-cdk/aws-logs.CrossAccountDestinationProps",
|
3313 | "kind": "interface",
|
3314 | "locationInModule": {
|
3315 | "filename": "lib/cross-account-destination.ts",
|
3316 | "line": 19
|
3317 | },
|
3318 | "name": "CrossAccountDestinationProps",
|
3319 | "properties": [
|
3320 | {
|
3321 | "abstract": true,
|
3322 | "docs": {
|
3323 | "remarks": "The role must be assumable by 'logs.{REGION}.amazonaws.com'.",
|
3324 | "stability": "stable",
|
3325 | "summary": "The role to assume that grants permissions to write to 'target'."
|
3326 | },
|
3327 | "immutable": true,
|
3328 | "locationInModule": {
|
3329 | "filename": "lib/cross-account-destination.ts",
|
3330 | "line": 32
|
3331 | },
|
3332 | "name": "role",
|
3333 | "type": {
|
3334 | "fqn": "@aws-cdk/aws-iam.IRole"
|
3335 | }
|
3336 | },
|
3337 | {
|
3338 | "abstract": true,
|
3339 | "docs": {
|
3340 | "stability": "stable",
|
3341 | "summary": "The log destination target's ARN."
|
3342 | },
|
3343 | "immutable": true,
|
3344 | "locationInModule": {
|
3345 | "filename": "lib/cross-account-destination.ts",
|
3346 | "line": 37
|
3347 | },
|
3348 | "name": "targetArn",
|
3349 | "type": {
|
3350 | "primitive": "string"
|
3351 | }
|
3352 | },
|
3353 | {
|
3354 | "abstract": true,
|
3355 | "docs": {
|
3356 | "default": "Automatically generated",
|
3357 | "stability": "stable",
|
3358 | "summary": "The name of the log destination."
|
3359 | },
|
3360 | "immutable": true,
|
3361 | "locationInModule": {
|
3362 | "filename": "lib/cross-account-destination.ts",
|
3363 | "line": 25
|
3364 | },
|
3365 | "name": "destinationName",
|
3366 | "optional": true,
|
3367 | "type": {
|
3368 | "primitive": "string"
|
3369 | }
|
3370 | }
|
3371 | ],
|
3372 | "symbolId": "lib/cross-account-destination:CrossAccountDestinationProps"
|
3373 | },
|
3374 | "@aws-cdk/aws-logs.FilterPattern": {
|
3375 | "assembly": "@aws-cdk/aws-logs",
|
3376 | "docs": {
|
3377 | "stability": "stable",
|
3378 | "summary": "A collection of static methods to generate appropriate ILogPatterns.",
|
3379 | "example": "// Search for lines that contain both \"ERROR\" and \"MainThread\"\nconst pattern1 = logs.FilterPattern.allTerms('ERROR', 'MainThread');\n\n// Search for lines that either contain both \"ERROR\" and \"MainThread\", or\n// both \"WARN\" and \"Deadlock\".\nconst pattern2 = logs.FilterPattern.anyTermGroup(\n ['ERROR', 'MainThread'],\n ['WARN', 'Deadlock'],\n);",
|
3380 | "custom": {
|
3381 | "exampleMetadata": "infused"
|
3382 | }
|
3383 | },
|
3384 | "fqn": "@aws-cdk/aws-logs.FilterPattern",
|
3385 | "initializer": {
|
3386 | "docs": {
|
3387 | "stability": "stable"
|
3388 | }
|
3389 | },
|
3390 | "kind": "class",
|
3391 | "locationInModule": {
|
3392 | "filename": "lib/pattern.ts",
|
3393 | "line": 26
|
3394 | },
|
3395 | "methods": [
|
3396 | {
|
3397 | "docs": {
|
3398 | "stability": "stable",
|
3399 | "summary": "A JSON log pattern that matches if all given JSON log patterns match."
|
3400 | },
|
3401 | "locationInModule": {
|
3402 | "filename": "lib/pattern.ts",
|
3403 | "line": 162
|
3404 | },
|
3405 | "name": "all",
|
3406 | "parameters": [
|
3407 | {
|
3408 | "name": "patterns",
|
3409 | "type": {
|
3410 | "fqn": "@aws-cdk/aws-logs.JsonPattern"
|
3411 | },
|
3412 | "variadic": true
|
3413 | }
|
3414 | ],
|
3415 | "returns": {
|
3416 | "type": {
|
3417 | "fqn": "@aws-cdk/aws-logs.JsonPattern"
|
3418 | }
|
3419 | },
|
3420 | "static": true,
|
3421 | "variadic": true
|
3422 | },
|
3423 | {
|
3424 | "docs": {
|
3425 | "stability": "stable",
|
3426 | "summary": "A log pattern that matches all events."
|
3427 | },
|
3428 | "locationInModule": {
|
3429 | "filename": "lib/pattern.ts",
|
3430 | "line": 43
|
3431 | },
|
3432 | "name": "allEvents",
|
3433 | "returns": {
|
3434 | "type": {
|
3435 | "fqn": "@aws-cdk/aws-logs.IFilterPattern"
|
3436 | }
|
3437 | },
|
3438 | "static": true
|
3439 | },
|
3440 | {
|
3441 | "docs": {
|
3442 | "stability": "stable",
|
3443 | "summary": "A log pattern that matches if all the strings given appear in the event."
|
3444 | },
|
3445 | "locationInModule": {
|
3446 | "filename": "lib/pattern.ts",
|
3447 | "line": 52
|
3448 | },
|
3449 | "name": "allTerms",
|
3450 | "parameters": [
|
3451 | {
|
3452 | "docs": {
|
3453 | "remarks": "All terms must match.",
|
3454 | "summary": "The words to search for."
|
3455 | },
|
3456 | "name": "terms",
|
3457 | "type": {
|
3458 | "primitive": "string"
|
3459 | },
|
3460 | "variadic": true
|
3461 | }
|
3462 | ],
|
3463 | "returns": {
|
3464 | "type": {
|
3465 | "fqn": "@aws-cdk/aws-logs.IFilterPattern"
|
3466 | }
|
3467 | },
|
3468 | "static": true,
|
3469 | "variadic": true
|
3470 | },
|
3471 | {
|
3472 | "docs": {
|
3473 | "stability": "stable",
|
3474 | "summary": "A JSON log pattern that matches if any of the given JSON log patterns match."
|
3475 | },
|
3476 | "locationInModule": {
|
3477 | "filename": "lib/pattern.ts",
|
3478 | "line": 171
|
3479 | },
|
3480 | "name": "any",
|
3481 | "parameters": [
|
3482 | {
|
3483 | "name": "patterns",
|
3484 | "type": {
|
3485 | "fqn": "@aws-cdk/aws-logs.JsonPattern"
|
3486 | },
|
3487 | "variadic": true
|
3488 | }
|
3489 | ],
|
3490 | "returns": {
|
3491 | "type": {
|
3492 | "fqn": "@aws-cdk/aws-logs.JsonPattern"
|
3493 | }
|
3494 | },
|
3495 | "static": true,
|
3496 | "variadic": true
|
3497 | },
|
3498 | {
|
3499 | "docs": {
|
3500 | "stability": "stable",
|
3501 | "summary": "A log pattern that matches if any of the strings given appear in the event."
|
3502 | },
|
3503 | "locationInModule": {
|
3504 | "filename": "lib/pattern.ts",
|
3505 | "line": 61
|
3506 | },
|
3507 | "name": "anyTerm",
|
3508 | "parameters": [
|
3509 | {
|
3510 | "docs": {
|
3511 | "remarks": "Any terms must match.",
|
3512 | "summary": "The words to search for."
|
3513 | },
|
3514 | "name": "terms",
|
3515 | "type": {
|
3516 | "primitive": "string"
|
3517 | },
|
3518 | "variadic": true
|
3519 | }
|
3520 | ],
|
3521 | "returns": {
|
3522 | "type": {
|
3523 | "fqn": "@aws-cdk/aws-logs.IFilterPattern"
|
3524 | }
|
3525 | },
|
3526 | "static": true,
|
3527 | "variadic": true
|
3528 | },
|
3529 | {
|
3530 | "docs": {
|
3531 | "remarks": "A term group matches an event if all the terms in it appear in the event string.",
|
3532 | "stability": "stable",
|
3533 | "summary": "A log pattern that matches if any of the given term groups matches the event."
|
3534 | },
|
3535 | "locationInModule": {
|
3536 | "filename": "lib/pattern.ts",
|
3537 | "line": 72
|
3538 | },
|
3539 | "name": "anyTermGroup",
|
3540 | "parameters": [
|
3541 | {
|
3542 | "docs": {
|
3543 | "remarks": "Any one of the clauses must match.",
|
3544 | "summary": "A list of term groups to search for."
|
3545 | },
|
3546 | "name": "termGroups",
|
3547 | "type": {
|
3548 | "collection": {
|
3549 | "elementtype": {
|
3550 | "primitive": "string"
|
3551 | },
|
3552 | "kind": "array"
|
3553 | }
|
3554 | },
|
3555 | "variadic": true
|
3556 | }
|
3557 | ],
|
3558 | "returns": {
|
3559 | "type": {
|
3560 | "fqn": "@aws-cdk/aws-logs.IFilterPattern"
|
3561 | }
|
3562 | },
|
3563 | "static": true,
|
3564 | "variadic": true
|
3565 | },
|
3566 | {
|
3567 | "docs": {
|
3568 | "stability": "stable",
|
3569 | "summary": "A JSON log pattern that matches if the field exists and equals the boolean value."
|
3570 | },
|
3571 | "locationInModule": {
|
3572 | "filename": "lib/pattern.ts",
|
3573 | "line": 155
|
3574 | },
|
3575 | "name": "booleanValue",
|
3576 | "parameters": [
|
3577 | {
|
3578 | "docs": {
|
3579 | "remarks": "Example: \"$.myField\"",
|
3580 | "summary": "Field inside JSON."
|
3581 | },
|
3582 | "name": "jsonField",
|
3583 | "type": {
|
3584 | "primitive": "string"
|
3585 | }
|
3586 | },
|
3587 | {
|
3588 | "docs": {
|
3589 | "summary": "The value to match."
|
3590 | },
|
3591 | "name": "value",
|
3592 | "type": {
|
3593 | "primitive": "boolean"
|
3594 | }
|
3595 | }
|
3596 | ],
|
3597 | "returns": {
|
3598 | "type": {
|
3599 | "fqn": "@aws-cdk/aws-logs.JsonPattern"
|
3600 | }
|
3601 | },
|
3602 | "static": true
|
3603 | },
|
3604 | {
|
3605 | "docs": {
|
3606 | "remarks": "This is a readable convenience wrapper over 'field = *'",
|
3607 | "stability": "stable",
|
3608 | "summary": "A JSON log patter that matches if the field exists."
|
3609 | },
|
3610 | "locationInModule": {
|
3611 | "filename": "lib/pattern.ts",
|
3612 | "line": 145
|
3613 | },
|
3614 | "name": "exists",
|
3615 | "parameters": [
|
3616 | {
|
3617 | "docs": {
|
3618 | "remarks": "Example: \"$.myField\"",
|
3619 | "summary": "Field inside JSON."
|
3620 | },
|
3621 | "name": "jsonField",
|
3622 | "type": {
|
3623 | "primitive": "string"
|
3624 | }
|
3625 | }
|
3626 | ],
|
3627 | "returns": {
|
3628 | "type": {
|
3629 | "fqn": "@aws-cdk/aws-logs.JsonPattern"
|
3630 | }
|
3631 | },
|
3632 | "static": true
|
3633 | },
|
3634 | {
|
3635 | "docs": {
|
3636 | "stability": "stable",
|
3637 | "summary": "A JSON log pattern that matches if the field exists and has the special value 'null'."
|
3638 | },
|
3639 | "locationInModule": {
|
3640 | "filename": "lib/pattern.ts",
|
3641 | "line": 125
|
3642 | },
|
3643 | "name": "isNull",
|
3644 | "parameters": [
|
3645 | {
|
3646 | "docs": {
|
3647 | "remarks": "Example: \"$.myField\"",
|
3648 | "summary": "Field inside JSON."
|
3649 | },
|
3650 | "name": "jsonField",
|
3651 | "type": {
|
3652 | "primitive": "string"
|
3653 | }
|
3654 | }
|
3655 | ],
|
3656 | "returns": {
|
3657 | "type": {
|
3658 | "fqn": "@aws-cdk/aws-logs.JsonPattern"
|
3659 | }
|
3660 | },
|
3661 | "static": true
|
3662 | },
|
3663 | {
|
3664 | "docs": {
|
3665 | "remarks": "See https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html\nfor information on writing log patterns.",
|
3666 | "stability": "stable",
|
3667 | "summary": "Use the given string as log pattern."
|
3668 | },
|
3669 | "locationInModule": {
|
3670 | "filename": "lib/pattern.ts",
|
3671 | "line": 36
|
3672 | },
|
3673 | "name": "literal",
|
3674 | "parameters": [
|
3675 | {
|
3676 | "docs": {
|
3677 | "summary": "The pattern string to use."
|
3678 | },
|
3679 | "name": "logPatternString",
|
3680 | "type": {
|
3681 | "primitive": "string"
|
3682 | }
|
3683 | }
|
3684 | ],
|
3685 | "returns": {
|
3686 | "type": {
|
3687 | "fqn": "@aws-cdk/aws-logs.IFilterPattern"
|
3688 | }
|
3689 | },
|
3690 | "static": true
|
3691 | },
|
3692 | {
|
3693 | "docs": {
|
3694 | "stability": "stable",
|
3695 | "summary": "A JSON log pattern that matches if the field does not exist."
|
3696 | },
|
3697 | "locationInModule": {
|
3698 | "filename": "lib/pattern.ts",
|
3699 | "line": 134
|
3700 | },
|
3701 | "name": "notExists",
|
3702 | "parameters": [
|
3703 | {
|
3704 | "docs": {
|
3705 | "remarks": "Example: \"$.myField\"",
|
3706 | "summary": "Field inside JSON."
|
3707 | },
|
3708 | "name": "jsonField",
|
3709 | "type": {
|
3710 | "primitive": "string"
|
3711 | }
|
3712 | }
|
3713 | ],
|
3714 | "returns": {
|
3715 | "type": {
|
3716 | "fqn": "@aws-cdk/aws-logs.JsonPattern"
|
3717 | }
|
3718 | },
|
3719 | "static": true
|
3720 | },
|
3721 | {
|
3722 | "docs": {
|
3723 | "remarks": "This pattern only matches if the event is a JSON event, and the indicated field inside\ncompares with the value in the indicated way.\n\nUse '$' to indicate the root of the JSON structure. The comparison operator can only\ncompare equality or inequality. The '*' wildcard may appear in the value may at the\nstart or at the end.\n\nFor more information, see:\n\nhttps://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html",
|
3724 | "stability": "stable",
|
3725 | "summary": "A JSON log pattern that compares numerical values."
|
3726 | },
|
3727 | "locationInModule": {
|
3728 | "filename": "lib/pattern.ts",
|
3729 | "line": 116
|
3730 | },
|
3731 | "name": "numberValue",
|
3732 | "parameters": [
|
3733 | {
|
3734 | "docs": {
|
3735 | "remarks": "Example: \"$.myField\"",
|
3736 | "summary": "Field inside JSON."
|
3737 | },
|
3738 | "name": "jsonField",
|
3739 | "type": {
|
3740 | "primitive": "string"
|
3741 | }
|
3742 | },
|
3743 | {
|
3744 | "docs": {
|
3745 | "remarks": "One of =, !=, <, <=, >, >=.",
|
3746 | "summary": "Comparison to carry out."
|
3747 | },
|
3748 | "name": "comparison",
|
3749 | "type": {
|
3750 | "primitive": "string"
|
3751 | }
|
3752 | },
|
3753 | {
|
3754 | "docs": {
|
3755 | "summary": "The numerical value to compare to."
|
3756 | },
|
3757 | "name": "value",
|
3758 | "type": {
|
3759 | "primitive": "number"
|
3760 | }
|
3761 | }
|
3762 | ],
|
3763 | "returns": {
|
3764 | "type": {
|
3765 | "fqn": "@aws-cdk/aws-logs.JsonPattern"
|
3766 | }
|
3767 | },
|
3768 | "static": true
|
3769 | },
|
3770 | {
|
3771 | "docs": {
|
3772 | "remarks": "The log event is divided into space-delimited columns (optionally\nenclosed by \"\" or [] to capture spaces into column values), and names\nare given to each column.\n\n'...' may be specified once to match any number of columns.\n\nAfterwards, conditions may be added to individual columns.",
|
3773 | "stability": "stable",
|
3774 | "summary": "A space delimited log pattern matcher."
|
3775 | },
|
3776 | "locationInModule": {
|
3777 | "filename": "lib/pattern.ts",
|
3778 | "line": 190
|
3779 | },
|
3780 | "name": "spaceDelimited",
|
3781 | "parameters": [
|
3782 | {
|
3783 | "docs": {
|
3784 | "summary": "The columns in the space-delimited log stream."
|
3785 | },
|
3786 | "name": "columns",
|
3787 | "type": {
|
3788 | "primitive": "string"
|
3789 | },
|
3790 | "variadic": true
|
3791 | }
|
3792 | ],
|
3793 | "returns": {
|
3794 | "type": {
|
3795 | "fqn": "@aws-cdk/aws-logs.SpaceDelimitedTextPattern"
|
3796 | }
|
3797 | },
|
3798 | "static": true,
|
3799 | "variadic": true
|
3800 | },
|
3801 | {
|
3802 | "docs": {
|
3803 | "remarks": "This pattern only matches if the event is a JSON event, and the indicated field inside\ncompares with the string value.\n\nUse '$' to indicate the root of the JSON structure. The comparison operator can only\ncompare equality or inequality. The '*' wildcard may appear in the value may at the\nstart or at the end.\n\nFor more information, see:\n\nhttps://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html",
|
3804 | "stability": "stable",
|
3805 | "summary": "A JSON log pattern that compares string values."
|
3806 | },
|
3807 | "locationInModule": {
|
3808 | "filename": "lib/pattern.ts",
|
3809 | "line": 94
|
3810 | },
|
3811 | "name": "stringValue",
|
3812 | "parameters": [
|
3813 | {
|
3814 | "docs": {
|
3815 | "remarks": "Example: \"$.myField\"",
|
3816 | "summary": "Field inside JSON."
|
3817 | },
|
3818 | "name": "jsonField",
|
3819 | "type": {
|
3820 | "primitive": "string"
|
3821 | }
|
3822 | },
|
3823 | {
|
3824 | "docs": {
|
3825 | "remarks": "Either = or !=.",
|
3826 | "summary": "Comparison to carry out."
|
3827 | },
|
3828 | "name": "comparison",
|
3829 | "type": {
|
3830 | "primitive": "string"
|
3831 | }
|
3832 | },
|
3833 | {
|
3834 | "docs": {
|
3835 | "remarks": "May use '*' as wildcard at start or end of string.",
|
3836 | "summary": "The string value to compare to."
|
3837 | },
|
3838 | "name": "value",
|
3839 | "type": {
|
3840 | "primitive": "string"
|
3841 | }
|
3842 | }
|
3843 | ],
|
3844 | "returns": {
|
3845 | "type": {
|
3846 | "fqn": "@aws-cdk/aws-logs.JsonPattern"
|
3847 | }
|
3848 | },
|
3849 | "static": true
|
3850 | }
|
3851 | ],
|
3852 | "name": "FilterPattern",
|
3853 | "symbolId": "lib/pattern:FilterPattern"
|
3854 | },
|
3855 | "@aws-cdk/aws-logs.IFilterPattern": {
|
3856 | "assembly": "@aws-cdk/aws-logs",
|
3857 | "docs": {
|
3858 | "stability": "stable",
|
3859 | "summary": "Interface for objects that can render themselves to log patterns."
|
3860 | },
|
3861 | "fqn": "@aws-cdk/aws-logs.IFilterPattern",
|
3862 | "kind": "interface",
|
3863 | "locationInModule": {
|
3864 | "filename": "lib/pattern.ts",
|
3865 | "line": 6
|
3866 | },
|
3867 | "name": "IFilterPattern",
|
3868 | "properties": [
|
3869 | {
|
3870 | "abstract": true,
|
3871 | "docs": {
|
3872 | "stability": "stable"
|
3873 | },
|
3874 | "immutable": true,
|
3875 | "locationInModule": {
|
3876 | "filename": "lib/pattern.ts",
|
3877 | "line": 7
|
3878 | },
|
3879 | "name": "logPatternString",
|
3880 | "type": {
|
3881 | "primitive": "string"
|
3882 | }
|
3883 | }
|
3884 | ],
|
3885 | "symbolId": "lib/pattern:IFilterPattern"
|
3886 | },
|
3887 | "@aws-cdk/aws-logs.ILogGroup": {
|
3888 | "assembly": "@aws-cdk/aws-logs",
|
3889 | "docs": {
|
3890 | "stability": "stable"
|
3891 | },
|
3892 | "fqn": "@aws-cdk/aws-logs.ILogGroup",
|
3893 | "interfaces": [
|
3894 | "@aws-cdk/aws-iam.IResourceWithPolicy"
|
3895 | ],
|
3896 | "kind": "interface",
|
3897 | "locationInModule": {
|
3898 | "filename": "lib/log-group.ts",
|
3899 | "line": 13
|
3900 | },
|
3901 | "methods": [
|
3902 | {
|
3903 | "abstract": true,
|
3904 | "docs": {
|
3905 | "stability": "stable",
|
3906 | "summary": "Create a new Metric Filter on this Log Group."
|
3907 | },
|
3908 | "locationInModule": {
|
3909 | "filename": "lib/log-group.ts",
|
3910 | "line": 49
|
3911 | },
|
3912 | "name": "addMetricFilter",
|
3913 | "parameters": [
|
3914 | {
|
3915 | "docs": {
|
3916 | "summary": "Unique identifier for the construct in its parent."
|
3917 | },
|
3918 | "name": "id",
|
3919 | "type": {
|
3920 | "primitive": "string"
|
3921 | }
|
3922 | },
|
3923 | {
|
3924 | "docs": {
|
3925 | "summary": "Properties for creating the MetricFilter."
|
3926 | },
|
3927 | "name": "props",
|
3928 | "type": {
|
3929 | "fqn": "@aws-cdk/aws-logs.MetricFilterOptions"
|
3930 | }
|
3931 | }
|
3932 | ],
|
3933 | "returns": {
|
3934 | "type": {
|
3935 | "fqn": "@aws-cdk/aws-logs.MetricFilter"
|
3936 | }
|
3937 | }
|
3938 | },
|
3939 | {
|
3940 | "abstract": true,
|
3941 | "docs": {
|
3942 | "stability": "stable",
|
3943 | "summary": "Create a new Log Stream for this Log Group."
|
3944 | },
|
3945 | "locationInModule": {
|
3946 | "filename": "lib/log-group.ts",
|
3947 | "line": 33
|
3948 | },
|
3949 | "name": "addStream",
|
3950 | "parameters": [
|
3951 | {
|
3952 | "docs": {
|
3953 | "summary": "Unique identifier for the construct in its parent."
|
3954 | },
|
3955 | "name": "id",
|
3956 | "type": {
|
3957 | "primitive": "string"
|
3958 | }
|
3959 | },
|
3960 | {
|
3961 | "docs": {
|
3962 | "summary": "Properties for creating the LogStream."
|
3963 | },
|
3964 | "name": "props",
|
3965 | "optional": true,
|
3966 | "type": {
|
3967 | "fqn": "@aws-cdk/aws-logs.StreamOptions"
|
3968 | }
|
3969 | }
|
3970 | ],
|
3971 | "returns": {
|
3972 | "type": {
|
3973 | "fqn": "@aws-cdk/aws-logs.LogStream"
|
3974 | }
|
3975 | }
|
3976 | },
|
3977 | {
|
3978 | "abstract": true,
|
3979 | "docs": {
|
3980 | "stability": "stable",
|
3981 | "summary": "Create a new Subscription Filter on this Log Group."
|
3982 | },
|
3983 | "locationInModule": {
|
3984 | "filename": "lib/log-group.ts",
|
3985 | "line": 41
|
3986 | },
|
3987 | "name": "addSubscriptionFilter",
|
3988 | "parameters": [
|
3989 | {
|
3990 | "docs": {
|
3991 | "summary": "Unique identifier for the construct in its parent."
|
3992 | },
|
3993 | "name": "id",
|
3994 | "type": {
|
3995 | "primitive": "string"
|
3996 | }
|
3997 | },
|
3998 | {
|
3999 | "docs": {
|
4000 | "summary": "Properties for creating the SubscriptionFilter."
|
4001 | },
|
4002 | "name": "props",
|
4003 | "type": {
|
4004 | "fqn": "@aws-cdk/aws-logs.SubscriptionFilterOptions"
|
4005 | }
|
4006 | }
|
4007 | ],
|
4008 | "returns": {
|
4009 | "type": {
|
4010 | "fqn": "@aws-cdk/aws-logs.SubscriptionFilter"
|
4011 | }
|
4012 | }
|
4013 | },
|
4014 | {
|
4015 | "abstract": true,
|
4016 | "docs": {
|
4017 | "remarks": "Creates a MetricFilter on this LogGroup that will extract the value\nof the indicated JSON field in all records where it occurs.\n\nThe metric will be available in CloudWatch Metrics under the\nindicated namespace and name.",
|
4018 | "returns": "A Metric object representing the extracted metric",
|
4019 | "stability": "stable",
|
4020 | "summary": "Extract a metric from structured log events in the LogGroup."
|
4021 | },
|
4022 | "locationInModule": {
|
4023 | "filename": "lib/log-group.ts",
|
4024 | "line": 65
|
4025 | },
|
4026 | "name": "extractMetric",
|
4027 | "parameters": [
|
4028 | {
|
4029 | "docs": {
|
4030 | "summary": "JSON field to extract (example: '$.myfield')."
|
4031 | },
|
4032 | "name": "jsonField",
|
4033 | "type": {
|
4034 | "primitive": "string"
|
4035 | }
|
4036 | },
|
4037 | {
|
4038 | "docs": {
|
4039 | "summary": "Namespace to emit the metric under."
|
4040 | },
|
4041 | "name": "metricNamespace",
|
4042 | "type": {
|
4043 | "primitive": "string"
|
4044 | }
|
4045 | },
|
4046 | {
|
4047 | "docs": {
|
4048 | "summary": "Name to emit the metric under."
|
4049 | },
|
4050 | "name": "metricName",
|
4051 | "type": {
|
4052 | "primitive": "string"
|
4053 | }
|
4054 | }
|
4055 | ],
|
4056 | "returns": {
|
4057 | "type": {
|
4058 | "fqn": "@aws-cdk/aws-cloudwatch.Metric"
|
4059 | }
|
4060 | }
|
4061 | },
|
4062 | {
|
4063 | "abstract": true,
|
4064 | "docs": {
|
4065 | "stability": "stable",
|
4066 | "summary": "Give the indicated permissions on this log group and all streams."
|
4067 | },
|
4068 | "locationInModule": {
|
4069 | "filename": "lib/log-group.ts",
|
4070 | "line": 75
|
4071 | },
|
4072 | "name": "grant",
|
4073 | "parameters": [
|
4074 | {
|
4075 | "name": "grantee",
|
4076 | "type": {
|
4077 | "fqn": "@aws-cdk/aws-iam.IGrantable"
|
4078 | }
|
4079 | },
|
4080 | {
|
4081 | "name": "actions",
|
4082 | "type": {
|
4083 | "primitive": "string"
|
4084 | },
|
4085 | "variadic": true
|
4086 | }
|
4087 | ],
|
4088 | "returns": {
|
4089 | "type": {
|
4090 | "fqn": "@aws-cdk/aws-iam.Grant"
|
4091 | }
|
4092 | },
|
4093 | "variadic": true
|
4094 | },
|
4095 | {
|
4096 | "abstract": true,
|
4097 | "docs": {
|
4098 | "stability": "stable",
|
4099 | "summary": "Give permissions to write to create and write to streams in this log group."
|
4100 | },
|
4101 | "locationInModule": {
|
4102 | "filename": "lib/log-group.ts",
|
4103 | "line": 70
|
4104 | },
|
4105 | "name": "grantWrite",
|
4106 | "parameters": [
|
4107 | {
|
4108 | "name": "grantee",
|
4109 | "type": {
|
4110 | "fqn": "@aws-cdk/aws-iam.IGrantable"
|
4111 | }
|
4112 | }
|
4113 | ],
|
4114 | "returns": {
|
4115 | "type": {
|
4116 | "fqn": "@aws-cdk/aws-iam.Grant"
|
4117 | }
|
4118 | }
|
4119 | },
|
4120 | {
|
4121 | "abstract": true,
|
4122 | "docs": {
|
4123 | "stability": "stable",
|
4124 | "summary": "Public method to get the physical name of this log group."
|
4125 | },
|
4126 | "locationInModule": {
|
4127 | "filename": "lib/log-group.ts",
|
4128 | "line": 80
|
4129 | },
|
4130 | "name": "logGroupPhysicalName",
|
4131 | "returns": {
|
4132 | "type": {
|
4133 | "primitive": "string"
|
4134 | }
|
4135 | }
|
4136 | }
|
4137 | ],
|
4138 | "name": "ILogGroup",
|
4139 | "properties": [
|
4140 | {
|
4141 | "abstract": true,
|
4142 | "docs": {
|
4143 | "custom": {
|
4144 | "attribute": "true"
|
4145 | },
|
4146 | "stability": "stable",
|
4147 | "summary": "The ARN of this log group, with ':*' appended."
|
4148 | },
|
4149 | "immutable": true,
|
4150 | "locationInModule": {
|
4151 | "filename": "lib/log-group.ts",
|
4152 | "line": 19
|
4153 | },
|
4154 | "name": "logGroupArn",
|
4155 | "type": {
|
4156 | "primitive": "string"
|
4157 | }
|
4158 | },
|
4159 | {
|
4160 | "abstract": true,
|
4161 | "docs": {
|
4162 | "custom": {
|
4163 | "attribute": "true"
|
4164 | },
|
4165 | "stability": "stable",
|
4166 | "summary": "The name of this log group."
|
4167 | },
|
4168 | "immutable": true,
|
4169 | "locationInModule": {
|
4170 | "filename": "lib/log-group.ts",
|
4171 | "line": 25
|
4172 | },
|
4173 | "name": "logGroupName",
|
4174 | "type": {
|
4175 | "primitive": "string"
|
4176 | }
|
4177 | }
|
4178 | ],
|
4179 | "symbolId": "lib/log-group:ILogGroup"
|
4180 | },
|
4181 | "@aws-cdk/aws-logs.ILogStream": {
|
4182 | "assembly": "@aws-cdk/aws-logs",
|
4183 | "docs": {
|
4184 | "stability": "stable"
|
4185 | },
|
4186 | "fqn": "@aws-cdk/aws-logs.ILogStream",
|
4187 | "interfaces": [
|
4188 | "@aws-cdk/core.IResource"
|
4189 | ],
|
4190 | "kind": "interface",
|
4191 | "locationInModule": {
|
4192 | "filename": "lib/log-stream.ts",
|
4193 | "line": 6
|
4194 | },
|
4195 | "name": "ILogStream",
|
4196 | "properties": [
|
4197 | {
|
4198 | "abstract": true,
|
4199 | "docs": {
|
4200 | "custom": {
|
4201 | "attribute": "true"
|
4202 | },
|
4203 | "stability": "stable",
|
4204 | "summary": "The name of this log stream."
|
4205 | },
|
4206 | "immutable": true,
|
4207 | "locationInModule": {
|
4208 | "filename": "lib/log-stream.ts",
|
4209 | "line": 11
|
4210 | },
|
4211 | "name": "logStreamName",
|
4212 | "type": {
|
4213 | "primitive": "string"
|
4214 | }
|
4215 | }
|
4216 | ],
|
4217 | "symbolId": "lib/log-stream:ILogStream"
|
4218 | },
|
4219 | "@aws-cdk/aws-logs.ILogSubscriptionDestination": {
|
4220 | "assembly": "@aws-cdk/aws-logs",
|
4221 | "docs": {
|
4222 | "stability": "stable",
|
4223 | "summary": "Interface for classes that can be the destination of a log Subscription."
|
4224 | },
|
4225 | "fqn": "@aws-cdk/aws-logs.ILogSubscriptionDestination",
|
4226 | "kind": "interface",
|
4227 | "locationInModule": {
|
4228 | "filename": "lib/subscription-filter.ts",
|
4229 | "line": 14
|
4230 | },
|
4231 | "methods": [
|
4232 | {
|
4233 | "abstract": true,
|
4234 | "docs": {
|
4235 | "remarks": "If necessary, the destination can use the properties of the SubscriptionFilter\nobject itself to configure its permissions to allow the subscription to write\nto it.\n\nThe destination may reconfigure its own permissions in response to this\nfunction call.",
|
4236 | "stability": "stable",
|
4237 | "summary": "Return the properties required to send subscription events to this destination."
|
4238 | },
|
4239 | "locationInModule": {
|
4240 | "filename": "lib/subscription-filter.ts",
|
4241 | "line": 25
|
4242 | },
|
4243 | "name": "bind",
|
4244 | "parameters": [
|
4245 | {
|
4246 | "name": "scope",
|
4247 | "type": {
|
4248 | "fqn": "@aws-cdk/core.Construct"
|
4249 | }
|
4250 | },
|
4251 | {
|
4252 | "name": "sourceLogGroup",
|
4253 | "type": {
|
4254 | "fqn": "@aws-cdk/aws-logs.ILogGroup"
|
4255 | }
|
4256 | }
|
4257 | ],
|
4258 | "returns": {
|
4259 | "type": {
|
4260 | "fqn": "@aws-cdk/aws-logs.LogSubscriptionDestinationConfig"
|
4261 | }
|
4262 | }
|
4263 | }
|
4264 | ],
|
4265 | "name": "ILogSubscriptionDestination",
|
4266 | "symbolId": "lib/subscription-filter:ILogSubscriptionDestination"
|
4267 | },
|
4268 | "@aws-cdk/aws-logs.JsonPattern": {
|
4269 | "abstract": true,
|
4270 | "assembly": "@aws-cdk/aws-logs",
|
4271 | "docs": {
|
4272 | "stability": "stable",
|
4273 | "summary": "Base class for patterns that only match JSON log events.",
|
4274 | "example": "// Search for all events where the component field is equal to\n// \"HttpServer\" and either error is true or the latency is higher\n// than 1000.\nconst pattern = logs.FilterPattern.all(\n logs.FilterPattern.stringValue('$.component', '=', 'HttpServer'),\n logs.FilterPattern.any(\n logs.FilterPattern.booleanValue('$.error', true),\n logs.FilterPattern.numberValue('$.latency', '>', 1000),\n ),\n);",
|
4275 | "custom": {
|
4276 | "exampleMetadata": "infused"
|
4277 | }
|
4278 | },
|
4279 | "fqn": "@aws-cdk/aws-logs.JsonPattern",
|
4280 | "initializer": {
|
4281 | "docs": {
|
4282 | "stability": "stable"
|
4283 | },
|
4284 | "locationInModule": {
|
4285 | "filename": "lib/pattern.ts",
|
4286 | "line": 16
|
4287 | },
|
4288 | "parameters": [
|
4289 | {
|
4290 | "name": "jsonPatternString",
|
4291 | "type": {
|
4292 | "primitive": "string"
|
4293 | }
|
4294 | }
|
4295 | ]
|
4296 | },
|
4297 | "interfaces": [
|
4298 | "@aws-cdk/aws-logs.IFilterPattern"
|
4299 | ],
|
4300 | "kind": "class",
|
4301 | "locationInModule": {
|
4302 | "filename": "lib/pattern.ts",
|
4303 | "line": 13
|
4304 | },
|
4305 | "name": "JsonPattern",
|
4306 | "properties": [
|
4307 | {
|
4308 | "docs": {
|
4309 | "stability": "stable"
|
4310 | },
|
4311 | "immutable": true,
|
4312 | "locationInModule": {
|
4313 | "filename": "lib/pattern.ts",
|
4314 | "line": 16
|
4315 | },
|
4316 | "name": "jsonPatternString",
|
4317 | "type": {
|
4318 | "primitive": "string"
|
4319 | }
|
4320 | },
|
4321 | {
|
4322 | "docs": {
|
4323 | "stability": "stable"
|
4324 | },
|
4325 | "immutable": true,
|
4326 | "locationInModule": {
|
4327 | "filename": "lib/pattern.ts",
|
4328 | "line": 18
|
4329 | },
|
4330 | "name": "logPatternString",
|
4331 | "overrides": "@aws-cdk/aws-logs.IFilterPattern",
|
4332 | "type": {
|
4333 | "primitive": "string"
|
4334 | }
|
4335 | }
|
4336 | ],
|
4337 | "symbolId": "lib/pattern:JsonPattern"
|
4338 | },
|
4339 | "@aws-cdk/aws-logs.LogGroup": {
|
4340 | "assembly": "@aws-cdk/aws-logs",
|
4341 | "base": "@aws-cdk/core.Resource",
|
4342 | "docs": {
|
4343 | "stability": "stable",
|
4344 | "summary": "Define a CloudWatch Log Group.",
|
4345 | "example": "import * as logs from '@aws-cdk/aws-logs';\n\nconst logGroup = new logs.LogGroup(this, 'Log Group');\nconst logBucket = new s3.Bucket(this, 'S3 Bucket')\n\nnew tasks.EmrContainersStartJobRun(this, 'EMR Containers Start Job Run', {\n virtualCluster: tasks.VirtualClusterInput.fromVirtualClusterId('de92jdei2910fwedz'),\n releaseLabel: tasks.ReleaseLabel.EMR_6_2_0,\n jobDriver: {\n sparkSubmitJobDriver: {\n entryPoint: sfn.TaskInput.fromText('local:///usr/lib/spark/examples/src/main/python/pi.py'),\n sparkSubmitParameters: '--conf spark.executor.instances=2 --conf spark.executor.memory=2G --conf spark.executor.cores=2 --conf spark.driver.cores=1',\n },\n },\n monitoring: {\n logGroup: logGroup,\n logBucket: logBucket,\n },\n});",
|
4346 | "custom": {
|
4347 | "exampleMetadata": "infused"
|
4348 | }
|
4349 | },
|
4350 | "fqn": "@aws-cdk/aws-logs.LogGroup",
|
4351 | "initializer": {
|
4352 | "docs": {
|
4353 | "stability": "stable"
|
4354 | },
|
4355 | "locationInModule": {
|
4356 | "filename": "lib/log-group.ts",
|
4357 | "line": 436
|
4358 | },
|
4359 | "parameters": [
|
4360 | {
|
4361 | "name": "scope",
|
4362 | "type": {
|
4363 | "fqn": "constructs.Construct"
|
4364 | }
|
4365 | },
|
4366 | {
|
4367 | "name": "id",
|
4368 | "type": {
|
4369 | "primitive": "string"
|
4370 | }
|
4371 | },
|
4372 | {
|
4373 | "name": "props",
|
4374 | "optional": true,
|
4375 | "type": {
|
4376 | "fqn": "@aws-cdk/aws-logs.LogGroupProps"
|
4377 | }
|
4378 | }
|
4379 | ]
|
4380 | },
|
4381 | "interfaces": [
|
4382 | "@aws-cdk/aws-logs.ILogGroup"
|
4383 | ],
|
4384 | "kind": "class",
|
4385 | "locationInModule": {
|
4386 | "filename": "lib/log-group.ts",
|
4387 | "line": 390
|
4388 | },
|
4389 | "methods": [
|
4390 | {
|
4391 | "docs": {
|
4392 | "stability": "stable",
|
4393 | "summary": "Import an existing LogGroup given its ARN."
|
4394 | },
|
4395 | "locationInModule": {
|
4396 | "filename": "lib/log-group.ts",
|
4397 | "line": 394
|
4398 | },
|
4399 | "name": "fromLogGroupArn",
|
4400 | "parameters": [
|
4401 | {
|
4402 | "name": "scope",
|
4403 | "type": {
|
4404 | "fqn": "constructs.Construct"
|
4405 | }
|
4406 | },
|
4407 | {
|
4408 | "name": "id",
|
4409 | "type": {
|
4410 | "primitive": "string"
|
4411 | }
|
4412 | },
|
4413 | {
|
4414 | "name": "logGroupArn",
|
4415 | "type": {
|
4416 | "primitive": "string"
|
4417 | }
|
4418 | }
|
4419 | ],
|
4420 | "returns": {
|
4421 | "type": {
|
4422 | "fqn": "@aws-cdk/aws-logs.ILogGroup"
|
4423 | }
|
4424 | },
|
4425 | "static": true
|
4426 | },
|
4427 | {
|
4428 | "docs": {
|
4429 | "stability": "stable",
|
4430 | "summary": "Import an existing LogGroup given its name."
|
4431 | },
|
4432 | "locationInModule": {
|
4433 | "filename": "lib/log-group.ts",
|
4434 | "line": 410
|
4435 | },
|
4436 | "name": "fromLogGroupName",
|
4437 | "parameters": [
|
4438 | {
|
4439 | "name": "scope",
|
4440 | "type": {
|
4441 | "fqn": "constructs.Construct"
|
4442 | }
|
4443 | },
|
4444 | {
|
4445 | "name": "id",
|
4446 | "type": {
|
4447 | "primitive": "string"
|
4448 | }
|
4449 | },
|
4450 | {
|
4451 | "name": "logGroupName",
|
4452 | "type": {
|
4453 | "primitive": "string"
|
4454 | }
|
4455 | }
|
4456 | ],
|
4457 | "returns": {
|
4458 | "type": {
|
4459 | "fqn": "@aws-cdk/aws-logs.ILogGroup"
|
4460 | }
|
4461 | },
|
4462 | "static": true
|
4463 | },
|
4464 | {
|
4465 | "docs": {
|
4466 | "stability": "stable",
|
4467 | "summary": "Create a new Metric Filter on this Log Group."
|
4468 | },
|
4469 | "locationInModule": {
|
4470 | "filename": "lib/log-group.ts",
|
4471 | "line": 132
|
4472 | },
|
4473 | "name": "addMetricFilter",
|
4474 | "overrides": "@aws-cdk/aws-logs.ILogGroup",
|
4475 | "parameters": [
|
4476 | {
|
4477 | "docs": {
|
4478 | "summary": "Unique identifier for the construct in its parent."
|
4479 | },
|
4480 | "name": "id",
|
4481 | "type": {
|
4482 | "primitive": "string"
|
4483 | }
|
4484 | },
|
4485 | {
|
4486 | "docs": {
|
4487 | "summary": "Properties for creating the MetricFilter."
|
4488 | },
|
4489 | "name": "props",
|
4490 | "type": {
|
4491 | "fqn": "@aws-cdk/aws-logs.MetricFilterOptions"
|
4492 | }
|
4493 | }
|
4494 | ],
|
4495 | "returns": {
|
4496 | "type": {
|
4497 | "fqn": "@aws-cdk/aws-logs.MetricFilter"
|
4498 | }
|
4499 | }
|
4500 | },
|
4501 | {
|
4502 | "docs": {
|
4503 | "stability": "stable",
|
4504 | "summary": "Create a new Log Stream for this Log Group."
|
4505 | },
|
4506 | "locationInModule": {
|
4507 | "filename": "lib/log-group.ts",
|
4508 | "line": 106
|
4509 | },
|
4510 | "name": "addStream",
|
4511 | "overrides": "@aws-cdk/aws-logs.ILogGroup",
|
4512 | "parameters": [
|
4513 | {
|
4514 | "docs": {
|
4515 | "summary": "Unique identifier for the construct in its parent."
|
4516 | },
|
4517 | "name": "id",
|
4518 | "type": {
|
4519 | "primitive": "string"
|
4520 | }
|
4521 | },
|
4522 | {
|
4523 | "docs": {
|
4524 | "summary": "Properties for creating the LogStream."
|
4525 | },
|
4526 | "name": "props",
|
4527 | "optional": true,
|
4528 | "type": {
|
4529 | "fqn": "@aws-cdk/aws-logs.StreamOptions"
|
4530 | }
|
4531 | }
|
4532 | ],
|
4533 | "returns": {
|
4534 | "type": {
|
4535 | "fqn": "@aws-cdk/aws-logs.LogStream"
|
4536 | }
|
4537 | }
|
4538 | },
|
4539 | {
|
4540 | "docs": {
|
4541 | "stability": "stable",
|
4542 | "summary": "Create a new Subscription Filter on this Log Group."
|
4543 | },
|
4544 | "locationInModule": {
|
4545 | "filename": "lib/log-group.ts",
|
4546 | "line": 119
|
4547 | },
|
4548 | "name": "addSubscriptionFilter",
|
4549 | "overrides": "@aws-cdk/aws-logs.ILogGroup",
|
4550 | "parameters": [
|
4551 | {
|
4552 | "docs": {
|
4553 | "summary": "Unique identifier for the construct in its parent."
|
4554 | },
|
4555 | "name": "id",
|
4556 | "type": {
|
4557 | "primitive": "string"
|
4558 | }
|
4559 | },
|
4560 | {
|
4561 | "docs": {
|
4562 | "summary": "Properties for creating the SubscriptionFilter."
|
4563 | },
|
4564 | "name": "props",
|
4565 | "type": {
|
4566 | "fqn": "@aws-cdk/aws-logs.SubscriptionFilterOptions"
|
4567 | }
|
4568 | }
|
4569 | ],
|
4570 | "returns": {
|
4571 | "type": {
|
4572 | "fqn": "@aws-cdk/aws-logs.SubscriptionFilter"
|
4573 | }
|
4574 | }
|
4575 | },
|
4576 | {
|
4577 | "docs": {
|
4578 | "remarks": "A resource policy will be automatically created upon the first call to `addToResourcePolicy`.\n\nAny ARN Principals inside of the statement will be converted into AWS Account ID strings\nbecause CloudWatch Logs Resource Policies do not accept ARN principals.",
|
4579 | "stability": "stable",
|
4580 | "summary": "Adds a statement to the resource policy associated with this log group."
|
4581 | },
|
4582 | "locationInModule": {
|
4583 | "filename": "lib/log-group.ts",
|
4584 | "line": 203
|
4585 | },
|
4586 | "name": "addToResourcePolicy",
|
4587 | "overrides": "@aws-cdk/aws-iam.IResourceWithPolicy",
|
4588 | "parameters": [
|
4589 | {
|
4590 | "docs": {
|
4591 | "summary": "The policy statement to add."
|
4592 | },
|
4593 | "name": "statement",
|
4594 | "type": {
|
4595 | "fqn": "@aws-cdk/aws-iam.PolicyStatement"
|
4596 | }
|
4597 | }
|
4598 | ],
|
4599 | "returns": {
|
4600 | "type": {
|
4601 | "fqn": "@aws-cdk/aws-iam.AddToResourcePolicyResult"
|
4602 | }
|
4603 | }
|
4604 | },
|
4605 | {
|
4606 | "docs": {
|
4607 | "remarks": "Creates a MetricFilter on this LogGroup that will extract the value\nof the indicated JSON field in all records where it occurs.\n\nThe metric will be available in CloudWatch Metrics under the\nindicated namespace and name.",
|
4608 | "returns": "A Metric object representing the extracted metric",
|
4609 | "stability": "stable",
|
4610 | "summary": "Extract a metric from structured log events in the LogGroup."
|
4611 | },
|
4612 | "locationInModule": {
|
4613 | "filename": "lib/log-group.ts",
|
4614 | "line": 153
|
4615 | },
|
4616 | "name": "extractMetric",
|
4617 | "overrides": "@aws-cdk/aws-logs.ILogGroup",
|
4618 | "parameters": [
|
4619 | {
|
4620 | "docs": {
|
4621 | "summary": "JSON field to extract (example: '$.myfield')."
|
4622 | },
|
4623 | "name": "jsonField",
|
4624 | "type": {
|
4625 | "primitive": "string"
|
4626 | }
|
4627 | },
|
4628 | {
|
4629 | "docs": {
|
4630 | "summary": "Namespace to emit the metric under."
|
4631 | },
|
4632 | "name": "metricNamespace",
|
4633 | "type": {
|
4634 | "primitive": "string"
|
4635 | }
|
4636 | },
|
4637 | {
|
4638 | "docs": {
|
4639 | "summary": "Name to emit the metric under."
|
4640 | },
|
4641 | "name": "metricName",
|
4642 | "type": {
|
4643 | "primitive": "string"
|
4644 | }
|
4645 | }
|
4646 | ],
|
4647 | "returns": {
|
4648 | "type": {
|
4649 | "fqn": "@aws-cdk/aws-cloudwatch.Metric"
|
4650 | }
|
4651 | }
|
4652 | },
|
4653 | {
|
4654 | "docs": {
|
4655 | "stability": "stable",
|
4656 | "summary": "Give the indicated permissions on this log group and all streams."
|
4657 | },
|
4658 | "locationInModule": {
|
4659 | "filename": "lib/log-group.ts",
|
4660 | "line": 175
|
4661 | },
|
4662 | "name": "grant",
|
4663 | "overrides": "@aws-cdk/aws-logs.ILogGroup",
|
4664 | "parameters": [
|
4665 | {
|
4666 | "name": "grantee",
|
4667 | "type": {
|
4668 | "fqn": "@aws-cdk/aws-iam.IGrantable"
|
4669 | }
|
4670 | },
|
4671 | {
|
4672 | "name": "actions",
|
4673 | "type": {
|
4674 | "primitive": "string"
|
4675 | },
|
4676 | "variadic": true
|
4677 | }
|
4678 | ],
|
4679 | "returns": {
|
4680 | "type": {
|
4681 | "fqn": "@aws-cdk/aws-iam.Grant"
|
4682 | }
|
4683 | },
|
4684 | "variadic": true
|
4685 | },
|
4686 | {
|
4687 | "docs": {
|
4688 | "stability": "stable",
|
4689 | "summary": "Give permissions to create and write to streams in this log group."
|
4690 | },
|
4691 | "locationInModule": {
|
4692 | "filename": "lib/log-group.ts",
|
4693 | "line": 168
|
4694 | },
|
4695 | "name": "grantWrite",
|
4696 | "overrides": "@aws-cdk/aws-logs.ILogGroup",
|
4697 | "parameters": [
|
4698 | {
|
4699 | "name": "grantee",
|
4700 | "type": {
|
4701 | "fqn": "@aws-cdk/aws-iam.IGrantable"
|
4702 | }
|
4703 | }
|
4704 | ],
|
4705 | "returns": {
|
4706 | "type": {
|
4707 | "fqn": "@aws-cdk/aws-iam.Grant"
|
4708 | }
|
4709 | }
|
4710 | },
|
4711 | {
|
4712 | "docs": {
|
4713 | "returns": "Physical name of log group",
|
4714 | "stability": "stable",
|
4715 | "summary": "Public method to get the physical name of this log group."
|
4716 | },
|
4717 | "locationInModule": {
|
4718 | "filename": "lib/log-group.ts",
|
4719 | "line": 190
|
4720 | },
|
4721 | "name": "logGroupPhysicalName",
|
4722 | "overrides": "@aws-cdk/aws-logs.ILogGroup",
|
4723 | "returns": {
|
4724 | "type": {
|
4725 | "primitive": "string"
|
4726 | }
|
4727 | }
|
4728 | }
|
4729 | ],
|
4730 | "name": "LogGroup",
|
4731 | "properties": [
|
4732 | {
|
4733 | "docs": {
|
4734 | "stability": "stable",
|
4735 | "summary": "The ARN of this log group."
|
4736 | },
|
4737 | "immutable": true,
|
4738 | "locationInModule": {
|
4739 | "filename": "lib/log-group.ts",
|
4740 | "line": 429
|
4741 | },
|
4742 | "name": "logGroupArn",
|
4743 | "overrides": "@aws-cdk/aws-logs.ILogGroup",
|
4744 | "type": {
|
4745 | "primitive": "string"
|
4746 | }
|
4747 | },
|
4748 | {
|
4749 | "docs": {
|
4750 | "stability": "stable",
|
4751 | "summary": "The name of this log group."
|
4752 | },
|
4753 | "immutable": true,
|
4754 | "locationInModule": {
|
4755 | "filename": "lib/log-group.ts",
|
4756 | "line": 434
|
4757 | },
|
4758 | "name": "logGroupName",
|
4759 | "overrides": "@aws-cdk/aws-logs.ILogGroup",
|
4760 | "type": {
|
4761 | "primitive": "string"
|
4762 | }
|
4763 | }
|
4764 | ],
|
4765 | "symbolId": "lib/log-group:LogGroup"
|
4766 | },
|
4767 | "@aws-cdk/aws-logs.LogGroupProps": {
|
4768 | "assembly": "@aws-cdk/aws-logs",
|
4769 | "datatype": true,
|
4770 | "docs": {
|
4771 | "stability": "stable",
|
4772 | "summary": "Properties for a LogGroup.",
|
4773 | "example": "declare const vpc: ec2.Vpc;\nconst kmsKey = new kms.Key(this, 'KmsKey');\n\n// Pass the KMS key in the `encryptionKey` field to associate the key to the log group\nconst logGroup = new logs.LogGroup(this, 'LogGroup', {\n encryptionKey: kmsKey,\n});\n\n// Pass the KMS key in the `encryptionKey` field to associate the key to the S3 bucket\nconst execBucket = new s3.Bucket(this, 'EcsExecBucket', {\n encryptionKey: kmsKey,\n});\n\nconst cluster = new ecs.Cluster(this, 'Cluster', {\n vpc,\n executeCommandConfiguration: {\n kmsKey,\n logConfiguration: {\n cloudWatchLogGroup: logGroup,\n cloudWatchEncryptionEnabled: true,\n s3Bucket: execBucket,\n s3EncryptionEnabled: true,\n s3KeyPrefix: 'exec-command-output',\n },\n logging: ecs.ExecuteCommandLogging.OVERRIDE,\n },\n});",
|
4774 | "custom": {
|
4775 | "exampleMetadata": "infused"
|
4776 | }
|
4777 | },
|
4778 | "fqn": "@aws-cdk/aws-logs.LogGroupProps",
|
4779 | "kind": "interface",
|
4780 | "locationInModule": {
|
4781 | "filename": "lib/log-group.ts",
|
4782 | "line": 350
|
4783 | },
|
4784 | "name": "LogGroupProps",
|
4785 | "properties": [
|
4786 | {
|
4787 | "abstract": true,
|
4788 | "docs": {
|
4789 | "default": "- log group is encrypted with the default master key",
|
4790 | "stability": "stable",
|
4791 | "summary": "The KMS Key to encrypt the log group with."
|
4792 | },
|
4793 | "immutable": true,
|
4794 | "locationInModule": {
|
4795 | "filename": "lib/log-group.ts",
|
4796 | "line": 356
|
4797 | },
|
4798 | "name": "encryptionKey",
|
4799 | "optional": true,
|
4800 | "type": {
|
4801 | "fqn": "@aws-cdk/aws-kms.IKey"
|
4802 | }
|
4803 | },
|
4804 | {
|
4805 | "abstract": true,
|
4806 | "docs": {
|
4807 | "default": "Automatically generated",
|
4808 | "stability": "stable",
|
4809 | "summary": "Name of the log group."
|
4810 | },
|
4811 | "immutable": true,
|
4812 | "locationInModule": {
|
4813 | "filename": "lib/log-group.ts",
|
4814 | "line": 363
|
4815 | },
|
4816 | "name": "logGroupName",
|
4817 | "optional": true,
|
4818 | "type": {
|
4819 | "primitive": "string"
|
4820 | }
|
4821 | },
|
4822 | {
|
4823 | "abstract": true,
|
4824 | "docs": {
|
4825 | "default": "RemovalPolicy.Retain",
|
4826 | "remarks": "Normally you want to retain the log group so you can diagnose issues\nfrom logs even after a deployment that no longer includes the log group.\nIn that case, use the normal date-based retention policy to age out your\nlogs.",
|
4827 | "stability": "stable",
|
4828 | "summary": "Determine the removal policy of this log group."
|
4829 | },
|
4830 | "immutable": true,
|
4831 | "locationInModule": {
|
4832 | "filename": "lib/log-group.ts",
|
4833 | "line": 384
|
4834 | },
|
4835 | "name": "removalPolicy",
|
4836 | "optional": true,
|
4837 | "type": {
|
4838 | "fqn": "@aws-cdk/core.RemovalPolicy"
|
4839 | }
|
4840 | },
|
4841 | {
|
4842 | "abstract": true,
|
4843 | "docs": {
|
4844 | "default": "RetentionDays.TWO_YEARS",
|
4845 | "remarks": "To retain all logs, set this value to RetentionDays.INFINITE.",
|
4846 | "stability": "stable",
|
4847 | "summary": "How long, in days, the log contents will be retained."
|
4848 | },
|
4849 | "immutable": true,
|
4850 | "locationInModule": {
|
4851 | "filename": "lib/log-group.ts",
|
4852 | "line": 372
|
4853 | },
|
4854 | "name": "retention",
|
4855 | "optional": true,
|
4856 | "type": {
|
4857 | "fqn": "@aws-cdk/aws-logs.RetentionDays"
|
4858 | }
|
4859 | }
|
4860 | ],
|
4861 | "symbolId": "lib/log-group:LogGroupProps"
|
4862 | },
|
4863 | "@aws-cdk/aws-logs.LogRetention": {
|
4864 | "assembly": "@aws-cdk/aws-logs",
|
4865 | "base": "@aws-cdk/core.Construct",
|
4866 | "docs": {
|
4867 | "remarks": "The log group is created if it doesn't already exist. The policy\nis removed when `retentionDays` is `undefined` or equal to `Infinity`.\nLog group can be created in the region that is different from stack region by\nspecifying `logGroupRegion`",
|
4868 | "stability": "stable",
|
4869 | "summary": "Creates a custom resource to control the retention policy of a CloudWatch Logs log group.",
|
4870 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as logs from '@aws-cdk/aws-logs';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const role: iam.Role;\nconst logRetention = new logs.LogRetention(this, 'MyLogRetention', {\n logGroupName: 'logGroupName',\n retention: logs.RetentionDays.ONE_DAY,\n\n // the properties below are optional\n logGroupRegion: 'logGroupRegion',\n logRetentionRetryOptions: {\n base: cdk.Duration.minutes(30),\n maxRetries: 123,\n },\n role: role,\n});",
|
4871 | "custom": {
|
4872 | "exampleMetadata": "fixture=_generated"
|
4873 | }
|
4874 | },
|
4875 | "fqn": "@aws-cdk/aws-logs.LogRetention",
|
4876 | "initializer": {
|
4877 | "docs": {
|
4878 | "stability": "stable"
|
4879 | },
|
4880 | "locationInModule": {
|
4881 | "filename": "lib/log-retention.ts",
|
4882 | "line": 83
|
4883 | },
|
4884 | "parameters": [
|
4885 | {
|
4886 | "name": "scope",
|
4887 | "type": {
|
4888 | "fqn": "constructs.Construct"
|
4889 | }
|
4890 | },
|
4891 | {
|
4892 | "name": "id",
|
4893 | "type": {
|
4894 | "primitive": "string"
|
4895 | }
|
4896 | },
|
4897 | {
|
4898 | "name": "props",
|
4899 | "type": {
|
4900 | "fqn": "@aws-cdk/aws-logs.LogRetentionProps"
|
4901 | }
|
4902 | }
|
4903 | ]
|
4904 | },
|
4905 | "kind": "class",
|
4906 | "locationInModule": {
|
4907 | "filename": "lib/log-retention.ts",
|
4908 | "line": 76
|
4909 | },
|
4910 | "name": "LogRetention",
|
4911 | "properties": [
|
4912 | {
|
4913 | "docs": {
|
4914 | "stability": "stable",
|
4915 | "summary": "The ARN of the LogGroup."
|
4916 | },
|
4917 | "immutable": true,
|
4918 | "locationInModule": {
|
4919 | "filename": "lib/log-retention.ts",
|
4920 | "line": 81
|
4921 | },
|
4922 | "name": "logGroupArn",
|
4923 | "type": {
|
4924 | "primitive": "string"
|
4925 | }
|
4926 | }
|
4927 | ],
|
4928 | "symbolId": "lib/log-retention:LogRetention"
|
4929 | },
|
4930 | "@aws-cdk/aws-logs.LogRetentionProps": {
|
4931 | "assembly": "@aws-cdk/aws-logs",
|
4932 | "datatype": true,
|
4933 | "docs": {
|
4934 | "stability": "stable",
|
4935 | "summary": "Construction properties for a LogRetention.",
|
4936 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as logs from '@aws-cdk/aws-logs';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const role: iam.Role;\nconst logRetentionProps: logs.LogRetentionProps = {\n logGroupName: 'logGroupName',\n retention: logs.RetentionDays.ONE_DAY,\n\n // the properties below are optional\n logGroupRegion: 'logGroupRegion',\n logRetentionRetryOptions: {\n base: cdk.Duration.minutes(30),\n maxRetries: 123,\n },\n role: role,\n};",
|
4937 | "custom": {
|
4938 | "exampleMetadata": "fixture=_generated"
|
4939 | }
|
4940 | },
|
4941 | "fqn": "@aws-cdk/aws-logs.LogRetentionProps",
|
4942 | "kind": "interface",
|
4943 | "locationInModule": {
|
4944 | "filename": "lib/log-retention.ts",
|
4945 | "line": 19
|
4946 | },
|
4947 | "name": "LogRetentionProps",
|
4948 | "properties": [
|
4949 | {
|
4950 | "abstract": true,
|
4951 | "docs": {
|
4952 | "stability": "stable",
|
4953 | "summary": "The log group name."
|
4954 | },
|
4955 | "immutable": true,
|
4956 | "locationInModule": {
|
4957 | "filename": "lib/log-retention.ts",
|
4958 | "line": 23
|
4959 | },
|
4960 | "name": "logGroupName",
|
4961 | "type": {
|
4962 | "primitive": "string"
|
4963 | }
|
4964 | },
|
4965 | {
|
4966 | "abstract": true,
|
4967 | "docs": {
|
4968 | "stability": "stable",
|
4969 | "summary": "The number of days log events are kept in CloudWatch Logs."
|
4970 | },
|
4971 | "immutable": true,
|
4972 | "locationInModule": {
|
4973 | "filename": "lib/log-retention.ts",
|
4974 | "line": 34
|
4975 | },
|
4976 | "name": "retention",
|
4977 | "type": {
|
4978 | "fqn": "@aws-cdk/aws-logs.RetentionDays"
|
4979 | }
|
4980 | },
|
4981 | {
|
4982 | "abstract": true,
|
4983 | "docs": {
|
4984 | "default": "- same region as the stack",
|
4985 | "stability": "stable",
|
4986 | "summary": "The region where the log group should be created."
|
4987 | },
|
4988 | "immutable": true,
|
4989 | "locationInModule": {
|
4990 | "filename": "lib/log-retention.ts",
|
4991 | "line": 29
|
4992 | },
|
4993 | "name": "logGroupRegion",
|
4994 | "optional": true,
|
4995 | "type": {
|
4996 | "primitive": "string"
|
4997 | }
|
4998 | },
|
4999 | {
|
5000 | "abstract": true,
|
5001 | "docs": {
|
5002 | "default": "- AWS SDK default retry options",
|
5003 | "stability": "stable",
|
5004 | "summary": "Retry options for all AWS API calls."
|
5005 | },
|
5006 | "immutable": true,
|
5007 | "locationInModule": {
|
5008 | "filename": "lib/log-retention.ts",
|
5009 | "line": 48
|
5010 | },
|
5011 | "name": "logRetentionRetryOptions",
|
5012 | "optional": true,
|
5013 | "type": {
|
5014 | "fqn": "@aws-cdk/aws-logs.LogRetentionRetryOptions"
|
5015 | }
|
5016 | },
|
5017 | {
|
5018 | "abstract": true,
|
5019 | "docs": {
|
5020 | "default": "- A new role is created",
|
5021 | "stability": "stable",
|
5022 | "summary": "The IAM role for the Lambda function associated with the custom resource."
|
5023 | },
|
5024 | "immutable": true,
|
5025 | "locationInModule": {
|
5026 | "filename": "lib/log-retention.ts",
|
5027 | "line": 41
|
5028 | },
|
5029 | "name": "role",
|
5030 | "optional": true,
|
5031 | "type": {
|
5032 | "fqn": "@aws-cdk/aws-iam.IRole"
|
5033 | }
|
5034 | }
|
5035 | ],
|
5036 | "symbolId": "lib/log-retention:LogRetentionProps"
|
5037 | },
|
5038 | "@aws-cdk/aws-logs.LogRetentionRetryOptions": {
|
5039 | "assembly": "@aws-cdk/aws-logs",
|
5040 | "datatype": true,
|
5041 | "docs": {
|
5042 | "stability": "stable",
|
5043 | "summary": "Retry options for all AWS API calls.",
|
5044 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as logs from '@aws-cdk/aws-logs';\nimport * as cdk from '@aws-cdk/core';\nconst logRetentionRetryOptions: logs.LogRetentionRetryOptions = {\n base: cdk.Duration.minutes(30),\n maxRetries: 123,\n};",
|
5045 | "custom": {
|
5046 | "exampleMetadata": "fixture=_generated"
|
5047 | }
|
5048 | },
|
5049 | "fqn": "@aws-cdk/aws-logs.LogRetentionRetryOptions",
|
5050 | "kind": "interface",
|
5051 | "locationInModule": {
|
5052 | "filename": "lib/log-retention.ts",
|
5053 | "line": 54
|
5054 | },
|
5055 | "name": "LogRetentionRetryOptions",
|
5056 | "properties": [
|
5057 | {
|
5058 | "abstract": true,
|
5059 | "docs": {
|
5060 | "default": "Duration.millis(100) (AWS SDK default)",
|
5061 | "stability": "stable",
|
5062 | "summary": "The base duration to use in the exponential backoff for operation retries."
|
5063 | },
|
5064 | "immutable": true,
|
5065 | "locationInModule": {
|
5066 | "filename": "lib/log-retention.ts",
|
5067 | "line": 66
|
5068 | },
|
5069 | "name": "base",
|
5070 | "optional": true,
|
5071 | "type": {
|
5072 | "fqn": "@aws-cdk/core.Duration"
|
5073 | }
|
5074 | },
|
5075 | {
|
5076 | "abstract": true,
|
5077 | "docs": {
|
5078 | "default": "3 (AWS SDK default)",
|
5079 | "stability": "stable",
|
5080 | "summary": "The maximum amount of retries."
|
5081 | },
|
5082 | "immutable": true,
|
5083 | "locationInModule": {
|
5084 | "filename": "lib/log-retention.ts",
|
5085 | "line": 60
|
5086 | },
|
5087 | "name": "maxRetries",
|
5088 | "optional": true,
|
5089 | "type": {
|
5090 | "primitive": "number"
|
5091 | }
|
5092 | }
|
5093 | ],
|
5094 | "symbolId": "lib/log-retention:LogRetentionRetryOptions"
|
5095 | },
|
5096 | "@aws-cdk/aws-logs.LogStream": {
|
5097 | "assembly": "@aws-cdk/aws-logs",
|
5098 | "base": "@aws-cdk/core.Resource",
|
5099 | "docs": {
|
5100 | "stability": "stable",
|
5101 | "summary": "Define a Log Stream in a Log Group.",
|
5102 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as logs from '@aws-cdk/aws-logs';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const logGroup: logs.LogGroup;\nconst logStream = new logs.LogStream(this, 'MyLogStream', {\n logGroup: logGroup,\n\n // the properties below are optional\n logStreamName: 'logStreamName',\n removalPolicy: cdk.RemovalPolicy.DESTROY,\n});",
|
5103 | "custom": {
|
5104 | "exampleMetadata": "fixture=_generated"
|
5105 | }
|
5106 | },
|
5107 | "fqn": "@aws-cdk/aws-logs.LogStream",
|
5108 | "initializer": {
|
5109 | "docs": {
|
5110 | "stability": "stable"
|
5111 | },
|
5112 | "locationInModule": {
|
5113 | "filename": "lib/log-stream.ts",
|
5114 | "line": 67
|
5115 | },
|
5116 | "parameters": [
|
5117 | {
|
5118 | "name": "scope",
|
5119 | "type": {
|
5120 | "fqn": "constructs.Construct"
|
5121 | }
|
5122 | },
|
5123 | {
|
5124 | "name": "id",
|
5125 | "type": {
|
5126 | "primitive": "string"
|
5127 | }
|
5128 | },
|
5129 | {
|
5130 | "name": "props",
|
5131 | "type": {
|
5132 | "fqn": "@aws-cdk/aws-logs.LogStreamProps"
|
5133 | }
|
5134 | }
|
5135 | ]
|
5136 | },
|
5137 | "interfaces": [
|
5138 | "@aws-cdk/aws-logs.ILogStream"
|
5139 | ],
|
5140 | "kind": "class",
|
5141 | "locationInModule": {
|
5142 | "filename": "lib/log-stream.ts",
|
5143 | "line": 50
|
5144 | },
|
5145 | "methods": [
|
5146 | {
|
5147 | "docs": {
|
5148 | "stability": "stable",
|
5149 | "summary": "Import an existing LogGroup."
|
5150 | },
|
5151 | "locationInModule": {
|
5152 | "filename": "lib/log-stream.ts",
|
5153 | "line": 54
|
5154 | },
|
5155 | "name": "fromLogStreamName",
|
5156 | "parameters": [
|
5157 | {
|
5158 | "name": "scope",
|
5159 | "type": {
|
5160 | "fqn": "constructs.Construct"
|
5161 | }
|
5162 | },
|
5163 | {
|
5164 | "name": "id",
|
5165 | "type": {
|
5166 | "primitive": "string"
|
5167 | }
|
5168 | },
|
5169 | {
|
5170 | "name": "logStreamName",
|
5171 | "type": {
|
5172 | "primitive": "string"
|
5173 | }
|
5174 | }
|
5175 | ],
|
5176 | "returns": {
|
5177 | "type": {
|
5178 | "fqn": "@aws-cdk/aws-logs.ILogStream"
|
5179 | }
|
5180 | },
|
5181 | "static": true
|
5182 | }
|
5183 | ],
|
5184 | "name": "LogStream",
|
5185 | "properties": [
|
5186 | {
|
5187 | "docs": {
|
5188 | "stability": "stable",
|
5189 | "summary": "The name of this log stream."
|
5190 | },
|
5191 | "immutable": true,
|
5192 | "locationInModule": {
|
5193 | "filename": "lib/log-stream.ts",
|
5194 | "line": 65
|
5195 | },
|
5196 | "name": "logStreamName",
|
5197 | "overrides": "@aws-cdk/aws-logs.ILogStream",
|
5198 | "type": {
|
5199 | "primitive": "string"
|
5200 | }
|
5201 | }
|
5202 | ],
|
5203 | "symbolId": "lib/log-stream:LogStream"
|
5204 | },
|
5205 | "@aws-cdk/aws-logs.LogStreamProps": {
|
5206 | "assembly": "@aws-cdk/aws-logs",
|
5207 | "datatype": true,
|
5208 | "docs": {
|
5209 | "stability": "stable",
|
5210 | "summary": "Properties for a LogStream.",
|
5211 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as logs from '@aws-cdk/aws-logs';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const logGroup: logs.LogGroup;\nconst logStreamProps: logs.LogStreamProps = {\n logGroup: logGroup,\n\n // the properties below are optional\n logStreamName: 'logStreamName',\n removalPolicy: cdk.RemovalPolicy.DESTROY,\n};",
|
5212 | "custom": {
|
5213 | "exampleMetadata": "fixture=_generated"
|
5214 | }
|
5215 | },
|
5216 | "fqn": "@aws-cdk/aws-logs.LogStreamProps",
|
5217 | "kind": "interface",
|
5218 | "locationInModule": {
|
5219 | "filename": "lib/log-stream.ts",
|
5220 | "line": 17
|
5221 | },
|
5222 | "name": "LogStreamProps",
|
5223 | "properties": [
|
5224 | {
|
5225 | "abstract": true,
|
5226 | "docs": {
|
5227 | "stability": "stable",
|
5228 | "summary": "The log group to create a log stream for."
|
5229 | },
|
5230 | "immutable": true,
|
5231 | "locationInModule": {
|
5232 | "filename": "lib/log-stream.ts",
|
5233 | "line": 21
|
5234 | },
|
5235 | "name": "logGroup",
|
5236 | "type": {
|
5237 | "fqn": "@aws-cdk/aws-logs.ILogGroup"
|
5238 | }
|
5239 | },
|
5240 | {
|
5241 | "abstract": true,
|
5242 | "docs": {
|
5243 | "default": "Automatically generated",
|
5244 | "remarks": "The name must be unique within the log group.",
|
5245 | "stability": "stable",
|
5246 | "summary": "The name of the log stream to create."
|
5247 | },
|
5248 | "immutable": true,
|
5249 | "locationInModule": {
|
5250 | "filename": "lib/log-stream.ts",
|
5251 | "line": 30
|
5252 | },
|
5253 | "name": "logStreamName",
|
5254 | "optional": true,
|
5255 | "type": {
|
5256 | "primitive": "string"
|
5257 | }
|
5258 | },
|
5259 | {
|
5260 | "abstract": true,
|
5261 | "docs": {
|
5262 | "default": "RemovalPolicy.Retain",
|
5263 | "remarks": "Normally you want to retain the log stream so you can diagnose issues from\nlogs even after a deployment that no longer includes the log stream.\n\nThe date-based retention policy of your log group will age out the logs\nafter a certain time.",
|
5264 | "stability": "stable",
|
5265 | "summary": "Determine what happens when the log stream resource is removed from the app."
|
5266 | },
|
5267 | "immutable": true,
|
5268 | "locationInModule": {
|
5269 | "filename": "lib/log-stream.ts",
|
5270 | "line": 44
|
5271 | },
|
5272 | "name": "removalPolicy",
|
5273 | "optional": true,
|
5274 | "type": {
|
5275 | "fqn": "@aws-cdk/core.RemovalPolicy"
|
5276 | }
|
5277 | }
|
5278 | ],
|
5279 | "symbolId": "lib/log-stream:LogStreamProps"
|
5280 | },
|
5281 | "@aws-cdk/aws-logs.LogSubscriptionDestinationConfig": {
|
5282 | "assembly": "@aws-cdk/aws-logs",
|
5283 | "datatype": true,
|
5284 | "docs": {
|
5285 | "stability": "stable",
|
5286 | "summary": "Properties returned by a Subscription destination.",
|
5287 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as logs from '@aws-cdk/aws-logs';\n\ndeclare const role: iam.Role;\nconst logSubscriptionDestinationConfig: logs.LogSubscriptionDestinationConfig = {\n arn: 'arn',\n\n // the properties below are optional\n role: role,\n};",
|
5288 | "custom": {
|
5289 | "exampleMetadata": "fixture=_generated"
|
5290 | }
|
5291 | },
|
5292 | "fqn": "@aws-cdk/aws-logs.LogSubscriptionDestinationConfig",
|
5293 | "kind": "interface",
|
5294 | "locationInModule": {
|
5295 | "filename": "lib/subscription-filter.ts",
|
5296 | "line": 31
|
5297 | },
|
5298 | "name": "LogSubscriptionDestinationConfig",
|
5299 | "properties": [
|
5300 | {
|
5301 | "abstract": true,
|
5302 | "docs": {
|
5303 | "stability": "stable",
|
5304 | "summary": "The ARN of the subscription's destination."
|
5305 | },
|
5306 | "immutable": true,
|
5307 | "locationInModule": {
|
5308 | "filename": "lib/subscription-filter.ts",
|
5309 | "line": 35
|
5310 | },
|
5311 | "name": "arn",
|
5312 | "type": {
|
5313 | "primitive": "string"
|
5314 | }
|
5315 | },
|
5316 | {
|
5317 | "abstract": true,
|
5318 | "docs": {
|
5319 | "default": "No role assumed",
|
5320 | "stability": "stable",
|
5321 | "summary": "The role to assume to write log events to the destination."
|
5322 | },
|
5323 | "immutable": true,
|
5324 | "locationInModule": {
|
5325 | "filename": "lib/subscription-filter.ts",
|
5326 | "line": 42
|
5327 | },
|
5328 | "name": "role",
|
5329 | "optional": true,
|
5330 | "type": {
|
5331 | "fqn": "@aws-cdk/aws-iam.IRole"
|
5332 | }
|
5333 | }
|
5334 | ],
|
5335 | "symbolId": "lib/subscription-filter:LogSubscriptionDestinationConfig"
|
5336 | },
|
5337 | "@aws-cdk/aws-logs.MetricFilter": {
|
5338 | "assembly": "@aws-cdk/aws-logs",
|
5339 | "base": "@aws-cdk/core.Resource",
|
5340 | "docs": {
|
5341 | "stability": "stable",
|
5342 | "summary": "A filter that extracts information from CloudWatch Logs and emits to CloudWatch Metrics.",
|
5343 | "example": "new MetricFilter(this, 'MetricFilter', {\n logGroup,\n metricNamespace: 'MyApp',\n metricName: 'Latency',\n filterPattern: FilterPattern.exists('$.latency'),\n metricValue: '$.latency',\n});",
|
5344 | "custom": {
|
5345 | "exampleMetadata": "lit=test/integ.metricfilter.lit.ts infused"
|
5346 | }
|
5347 | },
|
5348 | "fqn": "@aws-cdk/aws-logs.MetricFilter",
|
5349 | "initializer": {
|
5350 | "docs": {
|
5351 | "stability": "stable"
|
5352 | },
|
5353 | "locationInModule": {
|
5354 | "filename": "lib/metric-filter.ts",
|
5355 | "line": 25
|
5356 | },
|
5357 | "parameters": [
|
5358 | {
|
5359 | "name": "scope",
|
5360 | "type": {
|
5361 | "fqn": "constructs.Construct"
|
5362 | }
|
5363 | },
|
5364 | {
|
5365 | "name": "id",
|
5366 | "type": {
|
5367 | "primitive": "string"
|
5368 | }
|
5369 | },
|
5370 | {
|
5371 | "name": "props",
|
5372 | "type": {
|
5373 | "fqn": "@aws-cdk/aws-logs.MetricFilterProps"
|
5374 | }
|
5375 | }
|
5376 | ]
|
5377 | },
|
5378 | "kind": "class",
|
5379 | "locationInModule": {
|
5380 | "filename": "lib/metric-filter.ts",
|
5381 | "line": 20
|
5382 | },
|
5383 | "methods": [
|
5384 | {
|
5385 | "docs": {
|
5386 | "default": "avg over 5 minutes",
|
5387 | "stability": "stable",
|
5388 | "summary": "Return the given named metric for this Metric Filter."
|
5389 | },
|
5390 | "locationInModule": {
|
5391 | "filename": "lib/metric-filter.ts",
|
5392 | "line": 56
|
5393 | },
|
5394 | "name": "metric",
|
5395 | "parameters": [
|
5396 | {
|
5397 | "name": "props",
|
5398 | "optional": true,
|
5399 | "type": {
|
5400 | "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
|
5401 | }
|
5402 | }
|
5403 | ],
|
5404 | "returns": {
|
5405 | "type": {
|
5406 | "fqn": "@aws-cdk/aws-cloudwatch.Metric"
|
5407 | }
|
5408 | }
|
5409 | }
|
5410 | ],
|
5411 | "name": "MetricFilter",
|
5412 | "symbolId": "lib/metric-filter:MetricFilter"
|
5413 | },
|
5414 | "@aws-cdk/aws-logs.MetricFilterOptions": {
|
5415 | "assembly": "@aws-cdk/aws-logs",
|
5416 | "datatype": true,
|
5417 | "docs": {
|
5418 | "stability": "stable",
|
5419 | "summary": "Properties for a MetricFilter created from a LogGroup.",
|
5420 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as logs from '@aws-cdk/aws-logs';\n\ndeclare const filterPattern: logs.IFilterPattern;\nconst metricFilterOptions: logs.MetricFilterOptions = {\n filterPattern: filterPattern,\n metricName: 'metricName',\n metricNamespace: 'metricNamespace',\n\n // the properties below are optional\n defaultValue: 123,\n metricValue: 'metricValue',\n};",
|
5421 | "custom": {
|
5422 | "exampleMetadata": "fixture=_generated"
|
5423 | }
|
5424 | },
|
5425 | "fqn": "@aws-cdk/aws-logs.MetricFilterOptions",
|
5426 | "kind": "interface",
|
5427 | "locationInModule": {
|
5428 | "filename": "lib/log-group.ts",
|
5429 | "line": 501
|
5430 | },
|
5431 | "name": "MetricFilterOptions",
|
5432 | "properties": [
|
5433 | {
|
5434 | "abstract": true,
|
5435 | "docs": {
|
5436 | "stability": "stable",
|
5437 | "summary": "Pattern to search for log events."
|
5438 | },
|
5439 | "immutable": true,
|
5440 | "locationInModule": {
|
5441 | "filename": "lib/log-group.ts",
|
5442 | "line": 505
|
5443 | },
|
5444 | "name": "filterPattern",
|
5445 | "type": {
|
5446 | "fqn": "@aws-cdk/aws-logs.IFilterPattern"
|
5447 | }
|
5448 | },
|
5449 | {
|
5450 | "abstract": true,
|
5451 | "docs": {
|
5452 | "stability": "stable",
|
5453 | "summary": "The name of the metric to emit."
|
5454 | },
|
5455 | "immutable": true,
|
5456 | "locationInModule": {
|
5457 | "filename": "lib/log-group.ts",
|
5458 | "line": 515
|
5459 | },
|
5460 | "name": "metricName",
|
5461 | "type": {
|
5462 | "primitive": "string"
|
5463 | }
|
5464 | },
|
5465 | {
|
5466 | "abstract": true,
|
5467 | "docs": {
|
5468 | "stability": "stable",
|
5469 | "summary": "The namespace of the metric to emit."
|
5470 | },
|
5471 | "immutable": true,
|
5472 | "locationInModule": {
|
5473 | "filename": "lib/log-group.ts",
|
5474 | "line": 510
|
5475 | },
|
5476 | "name": "metricNamespace",
|
5477 | "type": {
|
5478 | "primitive": "string"
|
5479 | }
|
5480 | },
|
5481 | {
|
5482 | "abstract": true,
|
5483 | "docs": {
|
5484 | "default": "No metric emitted.",
|
5485 | "stability": "stable",
|
5486 | "summary": "The value to emit if the pattern does not match a particular event."
|
5487 | },
|
5488 | "immutable": true,
|
5489 | "locationInModule": {
|
5490 | "filename": "lib/log-group.ts",
|
5491 | "line": 539
|
5492 | },
|
5493 | "name": "defaultValue",
|
5494 | "optional": true,
|
5495 | "type": {
|
5496 | "primitive": "number"
|
5497 | }
|
5498 | },
|
5499 | {
|
5500 | "abstract": true,
|
5501 | "docs": {
|
5502 | "default": "\"1\"",
|
5503 | "remarks": "Can either be a literal number (typically \"1\"), or the name of a field in the structure\nto take the value from the matched event. If you are using a field value, the field\nvalue must have been matched using the pattern.\n\nIf you want to specify a field from a matched JSON structure, use '$.fieldName',\nand make sure the field is in the pattern (if only as '$.fieldName = *').\n\nIf you want to specify a field from a matched space-delimited structure,\nuse '$fieldName'.",
|
5504 | "stability": "stable",
|
5505 | "summary": "The value to emit for the metric."
|
5506 | },
|
5507 | "immutable": true,
|
5508 | "locationInModule": {
|
5509 | "filename": "lib/log-group.ts",
|
5510 | "line": 532
|
5511 | },
|
5512 | "name": "metricValue",
|
5513 | "optional": true,
|
5514 | "type": {
|
5515 | "primitive": "string"
|
5516 | }
|
5517 | }
|
5518 | ],
|
5519 | "symbolId": "lib/log-group:MetricFilterOptions"
|
5520 | },
|
5521 | "@aws-cdk/aws-logs.MetricFilterProps": {
|
5522 | "assembly": "@aws-cdk/aws-logs",
|
5523 | "datatype": true,
|
5524 | "docs": {
|
5525 | "stability": "stable",
|
5526 | "summary": "Properties for a MetricFilter.",
|
5527 | "example": "new MetricFilter(this, 'MetricFilter', {\n logGroup,\n metricNamespace: 'MyApp',\n metricName: 'Latency',\n filterPattern: FilterPattern.exists('$.latency'),\n metricValue: '$.latency',\n});",
|
5528 | "custom": {
|
5529 | "exampleMetadata": "lit=test/integ.metricfilter.lit.ts infused"
|
5530 | }
|
5531 | },
|
5532 | "fqn": "@aws-cdk/aws-logs.MetricFilterProps",
|
5533 | "interfaces": [
|
5534 | "@aws-cdk/aws-logs.MetricFilterOptions"
|
5535 | ],
|
5536 | "kind": "interface",
|
5537 | "locationInModule": {
|
5538 | "filename": "lib/metric-filter.ts",
|
5539 | "line": 10
|
5540 | },
|
5541 | "name": "MetricFilterProps",
|
5542 | "properties": [
|
5543 | {
|
5544 | "abstract": true,
|
5545 | "docs": {
|
5546 | "stability": "stable",
|
5547 | "summary": "The log group to create the filter on."
|
5548 | },
|
5549 | "immutable": true,
|
5550 | "locationInModule": {
|
5551 | "filename": "lib/metric-filter.ts",
|
5552 | "line": 14
|
5553 | },
|
5554 | "name": "logGroup",
|
5555 | "type": {
|
5556 | "fqn": "@aws-cdk/aws-logs.ILogGroup"
|
5557 | }
|
5558 | }
|
5559 | ],
|
5560 | "symbolId": "lib/metric-filter:MetricFilterProps"
|
5561 | },
|
5562 | "@aws-cdk/aws-logs.QueryDefinition": {
|
5563 | "assembly": "@aws-cdk/aws-logs",
|
5564 | "base": "@aws-cdk/core.Resource",
|
5565 | "docs": {
|
5566 | "stability": "stable",
|
5567 | "summary": "Define a query definition for CloudWatch Logs Insights.",
|
5568 | "example": "new logs.QueryDefinition(this, 'QueryDefinition', {\n queryDefinitionName: 'MyQuery',\n queryString: new logs.QueryString({\n fields: ['@timestamp', '@message'],\n sort: '@timestamp desc',\n limit: 20,\n }),\n});",
|
5569 | "custom": {
|
5570 | "exampleMetadata": "infused"
|
5571 | }
|
5572 | },
|
5573 | "fqn": "@aws-cdk/aws-logs.QueryDefinition",
|
5574 | "initializer": {
|
5575 | "docs": {
|
5576 | "stability": "stable"
|
5577 | },
|
5578 | "locationInModule": {
|
5579 | "filename": "lib/query-definition.ts",
|
5580 | "line": 152
|
5581 | },
|
5582 | "parameters": [
|
5583 | {
|
5584 | "name": "scope",
|
5585 | "type": {
|
5586 | "fqn": "constructs.Construct"
|
5587 | }
|
5588 | },
|
5589 | {
|
5590 | "name": "id",
|
5591 | "type": {
|
5592 | "primitive": "string"
|
5593 | }
|
5594 | },
|
5595 | {
|
5596 | "name": "props",
|
5597 | "type": {
|
5598 | "fqn": "@aws-cdk/aws-logs.QueryDefinitionProps"
|
5599 | }
|
5600 | }
|
5601 | ]
|
5602 | },
|
5603 | "kind": "class",
|
5604 | "locationInModule": {
|
5605 | "filename": "lib/query-definition.ts",
|
5606 | "line": 144
|
5607 | },
|
5608 | "name": "QueryDefinition",
|
5609 | "properties": [
|
5610 | {
|
5611 | "docs": {
|
5612 | "custom": {
|
5613 | "attribute": "true"
|
5614 | },
|
5615 | "stability": "stable",
|
5616 | "summary": "The ID of the query definition."
|
5617 | },
|
5618 | "immutable": true,
|
5619 | "locationInModule": {
|
5620 | "filename": "lib/query-definition.ts",
|
5621 | "line": 150
|
5622 | },
|
5623 | "name": "queryDefinitionId",
|
5624 | "type": {
|
5625 | "primitive": "string"
|
5626 | }
|
5627 | }
|
5628 | ],
|
5629 | "symbolId": "lib/query-definition:QueryDefinition"
|
5630 | },
|
5631 | "@aws-cdk/aws-logs.QueryDefinitionProps": {
|
5632 | "assembly": "@aws-cdk/aws-logs",
|
5633 | "datatype": true,
|
5634 | "docs": {
|
5635 | "stability": "stable",
|
5636 | "summary": "Properties for a QueryDefinition.",
|
5637 | "example": "new logs.QueryDefinition(this, 'QueryDefinition', {\n queryDefinitionName: 'MyQuery',\n queryString: new logs.QueryString({\n fields: ['@timestamp', '@message'],\n sort: '@timestamp desc',\n limit: 20,\n }),\n});",
|
5638 | "custom": {
|
5639 | "exampleMetadata": "infused"
|
5640 | }
|
5641 | },
|
5642 | "fqn": "@aws-cdk/aws-logs.QueryDefinitionProps",
|
5643 | "kind": "interface",
|
5644 | "locationInModule": {
|
5645 | "filename": "lib/query-definition.ts",
|
5646 | "line": 122
|
5647 | },
|
5648 | "name": "QueryDefinitionProps",
|
5649 | "properties": [
|
5650 | {
|
5651 | "abstract": true,
|
5652 | "docs": {
|
5653 | "stability": "stable",
|
5654 | "summary": "Name of the query definition."
|
5655 | },
|
5656 | "immutable": true,
|
5657 | "locationInModule": {
|
5658 | "filename": "lib/query-definition.ts",
|
5659 | "line": 126
|
5660 | },
|
5661 | "name": "queryDefinitionName",
|
5662 | "type": {
|
5663 | "primitive": "string"
|
5664 | }
|
5665 | },
|
5666 | {
|
5667 | "abstract": true,
|
5668 | "docs": {
|
5669 | "stability": "stable",
|
5670 | "summary": "The query string to use for this query definition."
|
5671 | },
|
5672 | "immutable": true,
|
5673 | "locationInModule": {
|
5674 | "filename": "lib/query-definition.ts",
|
5675 | "line": 131
|
5676 | },
|
5677 | "name": "queryString",
|
5678 | "type": {
|
5679 | "fqn": "@aws-cdk/aws-logs.QueryString"
|
5680 | }
|
5681 | },
|
5682 | {
|
5683 | "abstract": true,
|
5684 | "docs": {
|
5685 | "default": "- no specified log groups",
|
5686 | "stability": "stable",
|
5687 | "summary": "Specify certain log groups for the query definition."
|
5688 | },
|
5689 | "immutable": true,
|
5690 | "locationInModule": {
|
5691 | "filename": "lib/query-definition.ts",
|
5692 | "line": 138
|
5693 | },
|
5694 | "name": "logGroups",
|
5695 | "optional": true,
|
5696 | "type": {
|
5697 | "collection": {
|
5698 | "elementtype": {
|
5699 | "fqn": "@aws-cdk/aws-logs.ILogGroup"
|
5700 | },
|
5701 | "kind": "array"
|
5702 | }
|
5703 | }
|
5704 | }
|
5705 | ],
|
5706 | "symbolId": "lib/query-definition:QueryDefinitionProps"
|
5707 | },
|
5708 | "@aws-cdk/aws-logs.QueryString": {
|
5709 | "assembly": "@aws-cdk/aws-logs",
|
5710 | "docs": {
|
5711 | "stability": "stable",
|
5712 | "summary": "Define a QueryString.",
|
5713 | "example": "new logs.QueryDefinition(this, 'QueryDefinition', {\n queryDefinitionName: 'MyQuery',\n queryString: new logs.QueryString({\n fields: ['@timestamp', '@message'],\n sort: '@timestamp desc',\n limit: 20,\n }),\n});",
|
5714 | "custom": {
|
5715 | "exampleMetadata": "infused"
|
5716 | }
|
5717 | },
|
5718 | "fqn": "@aws-cdk/aws-logs.QueryString",
|
5719 | "initializer": {
|
5720 | "docs": {
|
5721 | "stability": "stable"
|
5722 | },
|
5723 | "locationInModule": {
|
5724 | "filename": "lib/query-definition.ts",
|
5725 | "line": 83
|
5726 | },
|
5727 | "parameters": [
|
5728 | {
|
5729 | "name": "props",
|
5730 | "optional": true,
|
5731 | "type": {
|
5732 | "fqn": "@aws-cdk/aws-logs.QueryStringProps"
|
5733 | }
|
5734 | }
|
5735 | ]
|
5736 | },
|
5737 | "kind": "class",
|
5738 | "locationInModule": {
|
5739 | "filename": "lib/query-definition.ts",
|
5740 | "line": 74
|
5741 | },
|
5742 | "methods": [
|
5743 | {
|
5744 | "docs": {
|
5745 | "stability": "stable",
|
5746 | "summary": "String representation of this QueryString."
|
5747 | },
|
5748 | "locationInModule": {
|
5749 | "filename": "lib/query-definition.ts",
|
5750 | "line": 96
|
5751 | },
|
5752 | "name": "toString",
|
5753 | "returns": {
|
5754 | "type": {
|
5755 | "primitive": "string"
|
5756 | }
|
5757 | }
|
5758 | }
|
5759 | ],
|
5760 | "name": "QueryString",
|
5761 | "symbolId": "lib/query-definition:QueryString"
|
5762 | },
|
5763 | "@aws-cdk/aws-logs.QueryStringProps": {
|
5764 | "assembly": "@aws-cdk/aws-logs",
|
5765 | "datatype": true,
|
5766 | "docs": {
|
5767 | "stability": "stable",
|
5768 | "summary": "Properties for a QueryString.",
|
5769 | "example": "new logs.QueryDefinition(this, 'QueryDefinition', {\n queryDefinitionName: 'MyQuery',\n queryString: new logs.QueryString({\n fields: ['@timestamp', '@message'],\n sort: '@timestamp desc',\n limit: 20,\n }),\n});",
|
5770 | "custom": {
|
5771 | "exampleMetadata": "infused"
|
5772 | }
|
5773 | },
|
5774 | "fqn": "@aws-cdk/aws-logs.QueryStringProps",
|
5775 | "kind": "interface",
|
5776 | "locationInModule": {
|
5777 | "filename": "lib/query-definition.ts",
|
5778 | "line": 10
|
5779 | },
|
5780 | "name": "QueryStringProps",
|
5781 | "properties": [
|
5782 | {
|
5783 | "abstract": true,
|
5784 | "docs": {
|
5785 | "default": "- no display in QueryString",
|
5786 | "stability": "stable",
|
5787 | "summary": "Specifies which fields to display in the query results."
|
5788 | },
|
5789 | "immutable": true,
|
5790 | "locationInModule": {
|
5791 | "filename": "lib/query-definition.ts",
|
5792 | "line": 58
|
5793 | },
|
5794 | "name": "display",
|
5795 | "optional": true,
|
5796 | "type": {
|
5797 | "primitive": "string"
|
5798 | }
|
5799 | },
|
5800 | {
|
5801 | "abstract": true,
|
5802 | "docs": {
|
5803 | "default": "- no fields in QueryString",
|
5804 | "stability": "stable",
|
5805 | "summary": "Retrieves the specified fields from log events for display."
|
5806 | },
|
5807 | "immutable": true,
|
5808 | "locationInModule": {
|
5809 | "filename": "lib/query-definition.ts",
|
5810 | "line": 16
|
5811 | },
|
5812 | "name": "fields",
|
5813 | "optional": true,
|
5814 | "type": {
|
5815 | "collection": {
|
5816 | "elementtype": {
|
5817 | "primitive": "string"
|
5818 | },
|
5819 | "kind": "array"
|
5820 | }
|
5821 | }
|
5822 | },
|
5823 | {
|
5824 | "abstract": true,
|
5825 | "docs": {
|
5826 | "default": "- no filter in QueryString",
|
5827 | "stability": "stable",
|
5828 | "summary": "Filters the results of a query that's based on one or more conditions."
|
5829 | },
|
5830 | "immutable": true,
|
5831 | "locationInModule": {
|
5832 | "filename": "lib/query-definition.ts",
|
5833 | "line": 30
|
5834 | },
|
5835 | "name": "filter",
|
5836 | "optional": true,
|
5837 | "type": {
|
5838 | "primitive": "string"
|
5839 | }
|
5840 | },
|
5841 | {
|
5842 | "abstract": true,
|
5843 | "docs": {
|
5844 | "default": "- no limit in QueryString",
|
5845 | "stability": "stable",
|
5846 | "summary": "Specifies the number of log events returned by the query."
|
5847 | },
|
5848 | "immutable": true,
|
5849 | "locationInModule": {
|
5850 | "filename": "lib/query-definition.ts",
|
5851 | "line": 51
|
5852 | },
|
5853 | "name": "limit",
|
5854 | "optional": true,
|
5855 | "type": {
|
5856 | "primitive": "number"
|
5857 | }
|
5858 | },
|
5859 | {
|
5860 | "abstract": true,
|
5861 | "docs": {
|
5862 | "default": "- no parse in QueryString",
|
5863 | "stability": "stable",
|
5864 | "summary": "Extracts data from a log field and creates one or more ephemeral fields that you can process further in the query."
|
5865 | },
|
5866 | "immutable": true,
|
5867 | "locationInModule": {
|
5868 | "filename": "lib/query-definition.ts",
|
5869 | "line": 23
|
5870 | },
|
5871 | "name": "parse",
|
5872 | "optional": true,
|
5873 | "type": {
|
5874 | "primitive": "string"
|
5875 | }
|
5876 | },
|
5877 | {
|
5878 | "abstract": true,
|
5879 | "docs": {
|
5880 | "default": "- no sort in QueryString",
|
5881 | "stability": "stable",
|
5882 | "summary": "Sorts the retrieved log events."
|
5883 | },
|
5884 | "immutable": true,
|
5885 | "locationInModule": {
|
5886 | "filename": "lib/query-definition.ts",
|
5887 | "line": 44
|
5888 | },
|
5889 | "name": "sort",
|
5890 | "optional": true,
|
5891 | "type": {
|
5892 | "primitive": "string"
|
5893 | }
|
5894 | },
|
5895 | {
|
5896 | "abstract": true,
|
5897 | "docs": {
|
5898 | "default": "- no stats in QueryString",
|
5899 | "stability": "stable",
|
5900 | "summary": "Uses log field values to calculate aggregate statistics."
|
5901 | },
|
5902 | "immutable": true,
|
5903 | "locationInModule": {
|
5904 | "filename": "lib/query-definition.ts",
|
5905 | "line": 37
|
5906 | },
|
5907 | "name": "stats",
|
5908 | "optional": true,
|
5909 | "type": {
|
5910 | "primitive": "string"
|
5911 | }
|
5912 | }
|
5913 | ],
|
5914 | "symbolId": "lib/query-definition:QueryStringProps"
|
5915 | },
|
5916 | "@aws-cdk/aws-logs.ResourcePolicy": {
|
5917 | "assembly": "@aws-cdk/aws-logs",
|
5918 | "base": "@aws-cdk/core.Resource",
|
5919 | "docs": {
|
5920 | "remarks": "Policies define the operations that are allowed on this resource.\n\nYou almost never need to define this construct directly.\n\nAll AWS resources that support resource policies have a method called\n`addToResourcePolicy()`, which will automatically create a new resource\npolicy if one doesn't exist yet, otherwise it will add to the existing\npolicy.\n\nPrefer to use `addToResourcePolicy()` instead.",
|
5921 | "stability": "stable",
|
5922 | "summary": "Resource Policy for CloudWatch Log Groups.",
|
5923 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as logs from '@aws-cdk/aws-logs';\n\ndeclare const policyStatement: iam.PolicyStatement;\nconst resourcePolicy = new logs.ResourcePolicy(this, 'MyResourcePolicy', /* all optional props */ {\n policyStatements: [policyStatement],\n resourcePolicyName: 'resourcePolicyName',\n});",
|
5924 | "custom": {
|
5925 | "exampleMetadata": "fixture=_generated"
|
5926 | }
|
5927 | },
|
5928 | "fqn": "@aws-cdk/aws-logs.ResourcePolicy",
|
5929 | "initializer": {
|
5930 | "docs": {
|
5931 | "stability": "stable"
|
5932 | },
|
5933 | "locationInModule": {
|
5934 | "filename": "lib/policy.ts",
|
5935 | "line": 44
|
5936 | },
|
5937 | "parameters": [
|
5938 | {
|
5939 | "name": "scope",
|
5940 | "type": {
|
5941 | "fqn": "constructs.Construct"
|
5942 | }
|
5943 | },
|
5944 | {
|
5945 | "name": "id",
|
5946 | "type": {
|
5947 | "primitive": "string"
|
5948 | }
|
5949 | },
|
5950 | {
|
5951 | "name": "props",
|
5952 | "optional": true,
|
5953 | "type": {
|
5954 | "fqn": "@aws-cdk/aws-logs.ResourcePolicyProps"
|
5955 | }
|
5956 | }
|
5957 | ]
|
5958 | },
|
5959 | "kind": "class",
|
5960 | "locationInModule": {
|
5961 | "filename": "lib/policy.ts",
|
5962 | "line": 38
|
5963 | },
|
5964 | "name": "ResourcePolicy",
|
5965 | "properties": [
|
5966 | {
|
5967 | "docs": {
|
5968 | "stability": "stable",
|
5969 | "summary": "The IAM policy document for this resource policy."
|
5970 | },
|
5971 | "immutable": true,
|
5972 | "locationInModule": {
|
5973 | "filename": "lib/policy.ts",
|
5974 | "line": 42
|
5975 | },
|
5976 | "name": "document",
|
5977 | "type": {
|
5978 | "fqn": "@aws-cdk/aws-iam.PolicyDocument"
|
5979 | }
|
5980 | }
|
5981 | ],
|
5982 | "symbolId": "lib/policy:ResourcePolicy"
|
5983 | },
|
5984 | "@aws-cdk/aws-logs.ResourcePolicyProps": {
|
5985 | "assembly": "@aws-cdk/aws-logs",
|
5986 | "datatype": true,
|
5987 | "docs": {
|
5988 | "stability": "stable",
|
5989 | "summary": "Properties to define Cloudwatch log group resource policy.",
|
5990 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as logs from '@aws-cdk/aws-logs';\n\ndeclare const policyStatement: iam.PolicyStatement;\nconst resourcePolicyProps: logs.ResourcePolicyProps = {\n policyStatements: [policyStatement],\n resourcePolicyName: 'resourcePolicyName',\n};",
|
5991 | "custom": {
|
5992 | "exampleMetadata": "fixture=_generated"
|
5993 | }
|
5994 | },
|
5995 | "fqn": "@aws-cdk/aws-logs.ResourcePolicyProps",
|
5996 | "kind": "interface",
|
5997 | "locationInModule": {
|
5998 | "filename": "lib/policy.ts",
|
5999 | "line": 9
|
6000 | },
|
6001 | "name": "ResourcePolicyProps",
|
6002 | "properties": [
|
6003 | {
|
6004 | "abstract": true,
|
6005 | "docs": {
|
6006 | "default": "- No statements",
|
6007 | "stability": "stable",
|
6008 | "summary": "Initial statements to add to the resource policy."
|
6009 | },
|
6010 | "immutable": true,
|
6011 | "locationInModule": {
|
6012 | "filename": "lib/policy.ts",
|
6013 | "line": 21
|
6014 | },
|
6015 | "name": "policyStatements",
|
6016 | "optional": true,
|
6017 | "type": {
|
6018 | "collection": {
|
6019 | "elementtype": {
|
6020 | "fqn": "@aws-cdk/aws-iam.PolicyStatement"
|
6021 | },
|
6022 | "kind": "array"
|
6023 | }
|
6024 | }
|
6025 | },
|
6026 | {
|
6027 | "abstract": true,
|
6028 | "docs": {
|
6029 | "default": "- Uses a unique id based on the construct path",
|
6030 | "stability": "stable",
|
6031 | "summary": "Name of the log group resource policy."
|
6032 | },
|
6033 | "immutable": true,
|
6034 | "locationInModule": {
|
6035 | "filename": "lib/policy.ts",
|
6036 | "line": 14
|
6037 | },
|
6038 | "name": "resourcePolicyName",
|
6039 | "optional": true,
|
6040 | "type": {
|
6041 | "primitive": "string"
|
6042 | }
|
6043 | }
|
6044 | ],
|
6045 | "symbolId": "lib/policy:ResourcePolicyProps"
|
6046 | },
|
6047 | "@aws-cdk/aws-logs.RetentionDays": {
|
6048 | "assembly": "@aws-cdk/aws-logs",
|
6049 | "docs": {
|
6050 | "stability": "stable",
|
6051 | "summary": "How long, in days, the log contents will be retained.",
|
6052 | "example": "import * as logs from '@aws-cdk/aws-logs';\ndeclare const myLogsPublishingRole: iam.Role;\ndeclare const vpc: ec2.Vpc;\n\n// Exporting logs from a cluster\nconst cluster = new rds.DatabaseCluster(this, 'Database', {\n engine: rds.DatabaseClusterEngine.aurora({\n version: rds.AuroraEngineVersion.VER_1_17_9, // different version class for each engine type\n }),\n instanceProps: {\n vpc,\n },\n cloudwatchLogsExports: ['error', 'general', 'slowquery', 'audit'], // Export all available MySQL-based logs\n cloudwatchLogsRetention: logs.RetentionDays.THREE_MONTHS, // Optional - default is to never expire logs\n cloudwatchLogsRetentionRole: myLogsPublishingRole, // Optional - a role will be created if not provided\n // ...\n});\n\n// Exporting logs from an instance\nconst instance = new rds.DatabaseInstance(this, 'Instance', {\n engine: rds.DatabaseInstanceEngine.postgres({\n version: rds.PostgresEngineVersion.VER_12_3,\n }),\n vpc,\n cloudwatchLogsExports: ['postgresql'], // Export the PostgreSQL logs\n // ...\n});",
|
6053 | "custom": {
|
6054 | "exampleMetadata": "infused"
|
6055 | }
|
6056 | },
|
6057 | "fqn": "@aws-cdk/aws-logs.RetentionDays",
|
6058 | "kind": "enum",
|
6059 | "locationInModule": {
|
6060 | "filename": "lib/log-group.ts",
|
6061 | "line": 235
|
6062 | },
|
6063 | "members": [
|
6064 | {
|
6065 | "docs": {
|
6066 | "stability": "stable",
|
6067 | "summary": "1 day."
|
6068 | },
|
6069 | "name": "ONE_DAY"
|
6070 | },
|
6071 | {
|
6072 | "docs": {
|
6073 | "stability": "stable",
|
6074 | "summary": "3 days."
|
6075 | },
|
6076 | "name": "THREE_DAYS"
|
6077 | },
|
6078 | {
|
6079 | "docs": {
|
6080 | "stability": "stable",
|
6081 | "summary": "5 days."
|
6082 | },
|
6083 | "name": "FIVE_DAYS"
|
6084 | },
|
6085 | {
|
6086 | "docs": {
|
6087 | "stability": "stable",
|
6088 | "summary": "1 week."
|
6089 | },
|
6090 | "name": "ONE_WEEK"
|
6091 | },
|
6092 | {
|
6093 | "docs": {
|
6094 | "stability": "stable",
|
6095 | "summary": "2 weeks."
|
6096 | },
|
6097 | "name": "TWO_WEEKS"
|
6098 | },
|
6099 | {
|
6100 | "docs": {
|
6101 | "stability": "stable",
|
6102 | "summary": "1 month."
|
6103 | },
|
6104 | "name": "ONE_MONTH"
|
6105 | },
|
6106 | {
|
6107 | "docs": {
|
6108 | "stability": "stable",
|
6109 | "summary": "2 months."
|
6110 | },
|
6111 | "name": "TWO_MONTHS"
|
6112 | },
|
6113 | {
|
6114 | "docs": {
|
6115 | "stability": "stable",
|
6116 | "summary": "3 months."
|
6117 | },
|
6118 | "name": "THREE_MONTHS"
|
6119 | },
|
6120 | {
|
6121 | "docs": {
|
6122 | "stability": "stable",
|
6123 | "summary": "4 months."
|
6124 | },
|
6125 | "name": "FOUR_MONTHS"
|
6126 | },
|
6127 | {
|
6128 | "docs": {
|
6129 | "stability": "stable",
|
6130 | "summary": "5 months."
|
6131 | },
|
6132 | "name": "FIVE_MONTHS"
|
6133 | },
|
6134 | {
|
6135 | "docs": {
|
6136 | "stability": "stable",
|
6137 | "summary": "6 months."
|
6138 | },
|
6139 | "name": "SIX_MONTHS"
|
6140 | },
|
6141 | {
|
6142 | "docs": {
|
6143 | "stability": "stable",
|
6144 | "summary": "1 year."
|
6145 | },
|
6146 | "name": "ONE_YEAR"
|
6147 | },
|
6148 | {
|
6149 | "docs": {
|
6150 | "stability": "stable",
|
6151 | "summary": "13 months."
|
6152 | },
|
6153 | "name": "THIRTEEN_MONTHS"
|
6154 | },
|
6155 | {
|
6156 | "docs": {
|
6157 | "stability": "stable",
|
6158 | "summary": "18 months."
|
6159 | },
|
6160 | "name": "EIGHTEEN_MONTHS"
|
6161 | },
|
6162 | {
|
6163 | "docs": {
|
6164 | "stability": "stable",
|
6165 | "summary": "2 years."
|
6166 | },
|
6167 | "name": "TWO_YEARS"
|
6168 | },
|
6169 | {
|
6170 | "docs": {
|
6171 | "stability": "stable",
|
6172 | "summary": "5 years."
|
6173 | },
|
6174 | "name": "FIVE_YEARS"
|
6175 | },
|
6176 | {
|
6177 | "docs": {
|
6178 | "stability": "stable",
|
6179 | "summary": "6 years."
|
6180 | },
|
6181 | "name": "SIX_YEARS"
|
6182 | },
|
6183 | {
|
6184 | "docs": {
|
6185 | "stability": "stable",
|
6186 | "summary": "7 years."
|
6187 | },
|
6188 | "name": "SEVEN_YEARS"
|
6189 | },
|
6190 | {
|
6191 | "docs": {
|
6192 | "stability": "stable",
|
6193 | "summary": "8 years."
|
6194 | },
|
6195 | "name": "EIGHT_YEARS"
|
6196 | },
|
6197 | {
|
6198 | "docs": {
|
6199 | "stability": "stable",
|
6200 | "summary": "9 years."
|
6201 | },
|
6202 | "name": "NINE_YEARS"
|
6203 | },
|
6204 | {
|
6205 | "docs": {
|
6206 | "stability": "stable",
|
6207 | "summary": "10 years."
|
6208 | },
|
6209 | "name": "TEN_YEARS"
|
6210 | },
|
6211 | {
|
6212 | "docs": {
|
6213 | "stability": "stable",
|
6214 | "summary": "Retain logs forever."
|
6215 | },
|
6216 | "name": "INFINITE"
|
6217 | }
|
6218 | ],
|
6219 | "name": "RetentionDays",
|
6220 | "symbolId": "lib/log-group:RetentionDays"
|
6221 | },
|
6222 | "@aws-cdk/aws-logs.SpaceDelimitedTextPattern": {
|
6223 | "assembly": "@aws-cdk/aws-logs",
|
6224 | "docs": {
|
6225 | "stability": "stable",
|
6226 | "summary": "Space delimited text pattern.",
|
6227 | "example": "// Search for all events where the component is \"HttpServer\" and the\n// result code is not equal to 200.\nconst pattern = logs.FilterPattern.spaceDelimited('time', 'component', '...', 'result_code', 'latency')\n .whereString('component', '=', 'HttpServer')\n .whereNumber('result_code', '!=', 200);",
|
6228 | "custom": {
|
6229 | "exampleMetadata": "infused"
|
6230 | }
|
6231 | },
|
6232 | "fqn": "@aws-cdk/aws-logs.SpaceDelimitedTextPattern",
|
6233 | "initializer": {
|
6234 | "docs": {
|
6235 | "stability": "stable"
|
6236 | },
|
6237 | "locationInModule": {
|
6238 | "filename": "lib/pattern.ts",
|
6239 | "line": 299
|
6240 | },
|
6241 | "parameters": [
|
6242 | {
|
6243 | "name": "columns",
|
6244 | "type": {
|
6245 | "collection": {
|
6246 | "elementtype": {
|
6247 | "primitive": "string"
|
6248 | },
|
6249 | "kind": "array"
|
6250 | }
|
6251 | }
|
6252 | },
|
6253 | {
|
6254 | "name": "restrictions",
|
6255 | "type": {
|
6256 | "collection": {
|
6257 | "elementtype": {
|
6258 | "collection": {
|
6259 | "elementtype": {
|
6260 | "fqn": "@aws-cdk/aws-logs.ColumnRestriction"
|
6261 | },
|
6262 | "kind": "array"
|
6263 | }
|
6264 | },
|
6265 | "kind": "map"
|
6266 | }
|
6267 | }
|
6268 | }
|
6269 | ],
|
6270 | "protected": true
|
6271 | },
|
6272 | "interfaces": [
|
6273 | "@aws-cdk/aws-logs.IFilterPattern"
|
6274 | ],
|
6275 | "kind": "class",
|
6276 | "locationInModule": {
|
6277 | "filename": "lib/pattern.ts",
|
6278 | "line": 271
|
6279 | },
|
6280 | "methods": [
|
6281 | {
|
6282 | "docs": {
|
6283 | "remarks": "Since this class must be public, we can't rely on the user only creating it through\nthe `LogPattern.spaceDelimited()` factory function. We must therefore validate the\nargument in the constructor. Since we're returning a copy on every mutation, and we\ndon't want to re-validate the same things on every construction, we provide a limited\nset of mutator functions and only validate the new data every time.",
|
6284 | "stability": "stable",
|
6285 | "summary": "Construct a new instance of a space delimited text pattern."
|
6286 | },
|
6287 | "locationInModule": {
|
6288 | "filename": "lib/pattern.ts",
|
6289 | "line": 281
|
6290 | },
|
6291 | "name": "construct",
|
6292 | "parameters": [
|
6293 | {
|
6294 | "name": "columns",
|
6295 | "type": {
|
6296 | "collection": {
|
6297 | "elementtype": {
|
6298 | "primitive": "string"
|
6299 | },
|
6300 | "kind": "array"
|
6301 | }
|
6302 | }
|
6303 | }
|
6304 | ],
|
6305 | "returns": {
|
6306 | "type": {
|
6307 | "fqn": "@aws-cdk/aws-logs.SpaceDelimitedTextPattern"
|
6308 | }
|
6309 | },
|
6310 | "static": true
|
6311 | },
|
6312 | {
|
6313 | "docs": {
|
6314 | "stability": "stable",
|
6315 | "summary": "Restrict where the pattern applies."
|
6316 | },
|
6317 | "locationInModule": {
|
6318 | "filename": "lib/pattern.ts",
|
6319 | "line": 325
|
6320 | },
|
6321 | "name": "whereNumber",
|
6322 | "parameters": [
|
6323 | {
|
6324 | "name": "columnName",
|
6325 | "type": {
|
6326 | "primitive": "string"
|
6327 | }
|
6328 | },
|
6329 | {
|
6330 | "name": "comparison",
|
6331 | "type": {
|
6332 | "primitive": "string"
|
6333 | }
|
6334 | },
|
6335 | {
|
6336 | "name": "value",
|
6337 | "type": {
|
6338 | "primitive": "number"
|
6339 | }
|
6340 | }
|
6341 | ],
|
6342 | "returns": {
|
6343 | "type": {
|
6344 | "fqn": "@aws-cdk/aws-logs.SpaceDelimitedTextPattern"
|
6345 | }
|
6346 | }
|
6347 | },
|
6348 | {
|
6349 | "docs": {
|
6350 | "stability": "stable",
|
6351 | "summary": "Restrict where the pattern applies."
|
6352 | },
|
6353 | "locationInModule": {
|
6354 | "filename": "lib/pattern.ts",
|
6355 | "line": 306
|
6356 | },
|
6357 | "name": "whereString",
|
6358 | "parameters": [
|
6359 | {
|
6360 | "name": "columnName",
|
6361 | "type": {
|
6362 | "primitive": "string"
|
6363 | }
|
6364 | },
|
6365 | {
|
6366 | "name": "comparison",
|
6367 | "type": {
|
6368 | "primitive": "string"
|
6369 | }
|
6370 | },
|
6371 | {
|
6372 | "name": "value",
|
6373 | "type": {
|
6374 | "primitive": "string"
|
6375 | }
|
6376 | }
|
6377 | ],
|
6378 | "returns": {
|
6379 | "type": {
|
6380 | "fqn": "@aws-cdk/aws-logs.SpaceDelimitedTextPattern"
|
6381 | }
|
6382 | }
|
6383 | }
|
6384 | ],
|
6385 | "name": "SpaceDelimitedTextPattern",
|
6386 | "properties": [
|
6387 | {
|
6388 | "docs": {
|
6389 | "stability": "stable"
|
6390 | },
|
6391 | "immutable": true,
|
6392 | "locationInModule": {
|
6393 | "filename": "lib/pattern.ts",
|
6394 | "line": 341
|
6395 | },
|
6396 | "name": "logPatternString",
|
6397 | "overrides": "@aws-cdk/aws-logs.IFilterPattern",
|
6398 | "type": {
|
6399 | "primitive": "string"
|
6400 | }
|
6401 | }
|
6402 | ],
|
6403 | "symbolId": "lib/pattern:SpaceDelimitedTextPattern"
|
6404 | },
|
6405 | "@aws-cdk/aws-logs.StreamOptions": {
|
6406 | "assembly": "@aws-cdk/aws-logs",
|
6407 | "datatype": true,
|
6408 | "docs": {
|
6409 | "stability": "stable",
|
6410 | "summary": "Properties for a new LogStream created from a LogGroup.",
|
6411 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as logs from '@aws-cdk/aws-logs';\nconst streamOptions: logs.StreamOptions = {\n logStreamName: 'logStreamName',\n};",
|
6412 | "custom": {
|
6413 | "exampleMetadata": "fixture=_generated"
|
6414 | }
|
6415 | },
|
6416 | "fqn": "@aws-cdk/aws-logs.StreamOptions",
|
6417 | "kind": "interface",
|
6418 | "locationInModule": {
|
6419 | "filename": "lib/log-group.ts",
|
6420 | "line": 470
|
6421 | },
|
6422 | "name": "StreamOptions",
|
6423 | "properties": [
|
6424 | {
|
6425 | "abstract": true,
|
6426 | "docs": {
|
6427 | "default": "Automatically generated",
|
6428 | "remarks": "The name must be unique within the log group.",
|
6429 | "stability": "stable",
|
6430 | "summary": "The name of the log stream to create."
|
6431 | },
|
6432 | "immutable": true,
|
6433 | "locationInModule": {
|
6434 | "filename": "lib/log-group.ts",
|
6435 | "line": 478
|
6436 | },
|
6437 | "name": "logStreamName",
|
6438 | "optional": true,
|
6439 | "type": {
|
6440 | "primitive": "string"
|
6441 | }
|
6442 | }
|
6443 | ],
|
6444 | "symbolId": "lib/log-group:StreamOptions"
|
6445 | },
|
6446 | "@aws-cdk/aws-logs.SubscriptionFilter": {
|
6447 | "assembly": "@aws-cdk/aws-logs",
|
6448 | "base": "@aws-cdk/core.Resource",
|
6449 | "docs": {
|
6450 | "stability": "stable",
|
6451 | "summary": "A new Subscription on a CloudWatch log group.",
|
6452 | "example": "import * as destinations from '@aws-cdk/aws-logs-destinations';\ndeclare const fn: lambda.Function;\ndeclare const logGroup: logs.LogGroup;\n\nnew logs.SubscriptionFilter(this, 'Subscription', {\n logGroup,\n destination: new destinations.LambdaDestination(fn),\n filterPattern: logs.FilterPattern.allTerms(\"ERROR\", \"MainThread\"),\n});",
|
6453 | "custom": {
|
6454 | "exampleMetadata": "infused"
|
6455 | }
|
6456 | },
|
6457 | "fqn": "@aws-cdk/aws-logs.SubscriptionFilter",
|
6458 | "initializer": {
|
6459 | "docs": {
|
6460 | "stability": "stable"
|
6461 | },
|
6462 | "locationInModule": {
|
6463 | "filename": "lib/subscription-filter.ts",
|
6464 | "line": 59
|
6465 | },
|
6466 | "parameters": [
|
6467 | {
|
6468 | "name": "scope",
|
6469 | "type": {
|
6470 | "fqn": "constructs.Construct"
|
6471 | }
|
6472 | },
|
6473 | {
|
6474 | "name": "id",
|
6475 | "type": {
|
6476 | "primitive": "string"
|
6477 | }
|
6478 | },
|
6479 | {
|
6480 | "name": "props",
|
6481 | "type": {
|
6482 | "fqn": "@aws-cdk/aws-logs.SubscriptionFilterProps"
|
6483 | }
|
6484 | }
|
6485 | ]
|
6486 | },
|
6487 | "kind": "class",
|
6488 | "locationInModule": {
|
6489 | "filename": "lib/subscription-filter.ts",
|
6490 | "line": 58
|
6491 | },
|
6492 | "name": "SubscriptionFilter",
|
6493 | "symbolId": "lib/subscription-filter:SubscriptionFilter"
|
6494 | },
|
6495 | "@aws-cdk/aws-logs.SubscriptionFilterOptions": {
|
6496 | "assembly": "@aws-cdk/aws-logs",
|
6497 | "datatype": true,
|
6498 | "docs": {
|
6499 | "stability": "stable",
|
6500 | "summary": "Properties for a new SubscriptionFilter created from a LogGroup.",
|
6501 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as logs from '@aws-cdk/aws-logs';\n\ndeclare const filterPattern: logs.IFilterPattern;\ndeclare const logSubscriptionDestination: logs.ILogSubscriptionDestination;\nconst subscriptionFilterOptions: logs.SubscriptionFilterOptions = {\n destination: logSubscriptionDestination,\n filterPattern: filterPattern,\n};",
|
6502 | "custom": {
|
6503 | "exampleMetadata": "fixture=_generated"
|
6504 | }
|
6505 | },
|
6506 | "fqn": "@aws-cdk/aws-logs.SubscriptionFilterOptions",
|
6507 | "kind": "interface",
|
6508 | "locationInModule": {
|
6509 | "filename": "lib/log-group.ts",
|
6510 | "line": 484
|
6511 | },
|
6512 | "name": "SubscriptionFilterOptions",
|
6513 | "properties": [
|
6514 | {
|
6515 | "abstract": true,
|
6516 | "docs": {
|
6517 | "remarks": "For example, a Kinesis stream or a Lambda function.",
|
6518 | "stability": "stable",
|
6519 | "summary": "The destination to send the filtered events to."
|
6520 | },
|
6521 | "immutable": true,
|
6522 | "locationInModule": {
|
6523 | "filename": "lib/log-group.ts",
|
6524 | "line": 490
|
6525 | },
|
6526 | "name": "destination",
|
6527 | "type": {
|
6528 | "fqn": "@aws-cdk/aws-logs.ILogSubscriptionDestination"
|
6529 | }
|
6530 | },
|
6531 | {
|
6532 | "abstract": true,
|
6533 | "docs": {
|
6534 | "stability": "stable",
|
6535 | "summary": "Log events matching this pattern will be sent to the destination."
|
6536 | },
|
6537 | "immutable": true,
|
6538 | "locationInModule": {
|
6539 | "filename": "lib/log-group.ts",
|
6540 | "line": 495
|
6541 | },
|
6542 | "name": "filterPattern",
|
6543 | "type": {
|
6544 | "fqn": "@aws-cdk/aws-logs.IFilterPattern"
|
6545 | }
|
6546 | }
|
6547 | ],
|
6548 | "symbolId": "lib/log-group:SubscriptionFilterOptions"
|
6549 | },
|
6550 | "@aws-cdk/aws-logs.SubscriptionFilterProps": {
|
6551 | "assembly": "@aws-cdk/aws-logs",
|
6552 | "datatype": true,
|
6553 | "docs": {
|
6554 | "stability": "stable",
|
6555 | "summary": "Properties for a SubscriptionFilter.",
|
6556 | "example": "import * as destinations from '@aws-cdk/aws-logs-destinations';\ndeclare const fn: lambda.Function;\ndeclare const logGroup: logs.LogGroup;\n\nnew logs.SubscriptionFilter(this, 'Subscription', {\n logGroup,\n destination: new destinations.LambdaDestination(fn),\n filterPattern: logs.FilterPattern.allTerms(\"ERROR\", \"MainThread\"),\n});",
|
6557 | "custom": {
|
6558 | "exampleMetadata": "infused"
|
6559 | }
|
6560 | },
|
6561 | "fqn": "@aws-cdk/aws-logs.SubscriptionFilterProps",
|
6562 | "interfaces": [
|
6563 | "@aws-cdk/aws-logs.SubscriptionFilterOptions"
|
6564 | ],
|
6565 | "kind": "interface",
|
6566 | "locationInModule": {
|
6567 | "filename": "lib/subscription-filter.ts",
|
6568 | "line": 48
|
6569 | },
|
6570 | "name": "SubscriptionFilterProps",
|
6571 | "properties": [
|
6572 | {
|
6573 | "abstract": true,
|
6574 | "docs": {
|
6575 | "stability": "stable",
|
6576 | "summary": "The log group to create the subscription on."
|
6577 | },
|
6578 | "immutable": true,
|
6579 | "locationInModule": {
|
6580 | "filename": "lib/subscription-filter.ts",
|
6581 | "line": 52
|
6582 | },
|
6583 | "name": "logGroup",
|
6584 | "type": {
|
6585 | "fqn": "@aws-cdk/aws-logs.ILogGroup"
|
6586 | }
|
6587 | }
|
6588 | ],
|
6589 | "symbolId": "lib/subscription-filter:SubscriptionFilterProps"
|
6590 | }
|
6591 | },
|
6592 | "version": "1.198.0",
|
6593 | "fingerprint": "**********"
|
6594 | } |
\ | No newline at end of file |