{ "author": { "name": "Amazon Web Services", "organization": true, "roles": [ "author" ], "url": "https://aws.amazon.com" }, "dependencies": { "@aws-cdk/aws-cloudwatch": "1.64.0", "@aws-cdk/aws-iam": "1.64.0", "@aws-cdk/aws-s3-assets": "1.64.0", "@aws-cdk/core": "1.64.0", "constructs": "^3.0.4" }, "dependencyClosure": { "@aws-cdk/assets": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.Assets", "packageId": "Amazon.CDK.Assets", "signAssembly": true }, "java": { "maven": { "artifactId": "cdk-assets", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.assets" }, "js": { "npm": "@aws-cdk/assets" }, "python": { "distName": "aws-cdk.assets", "module": "aws_cdk.assets" } } }, "@aws-cdk/aws-cloudwatch": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CloudWatch", "packageId": "Amazon.CDK.AWS.CloudWatch", "signAssembly": true }, "java": { "maven": { "artifactId": "cloudwatch", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.cloudwatch" }, "js": { "npm": "@aws-cdk/aws-cloudwatch" }, "python": { "distName": "aws-cdk.aws-cloudwatch", "module": "aws_cdk.aws_cloudwatch" } } }, "@aws-cdk/aws-events": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Events", "packageId": "Amazon.CDK.AWS.Events", "signAssembly": true }, "java": { "maven": { "artifactId": "events", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.events" }, "js": { "npm": "@aws-cdk/aws-events" }, "python": { "distName": "aws-cdk.aws-events", "module": "aws_cdk.aws_events" } } }, "@aws-cdk/aws-iam": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.IAM", "packageId": "Amazon.CDK.AWS.IAM", "signAssembly": true }, "java": { "maven": { "artifactId": "iam", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.iam" }, "js": { "npm": "@aws-cdk/aws-iam" }, "python": { "distName": "aws-cdk.aws-iam", "module": "aws_cdk.aws_iam" } } }, "@aws-cdk/aws-kms": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.KMS", "packageId": "Amazon.CDK.AWS.KMS", "signAssembly": true }, "java": { "maven": { "artifactId": "kms", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.kms" }, "js": { "npm": "@aws-cdk/aws-kms" }, "python": { "distName": "aws-cdk.aws-kms", "module": "aws_cdk.aws_kms" } } }, "@aws-cdk/aws-s3": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.S3", "packageId": "Amazon.CDK.AWS.S3", "signAssembly": true }, "java": { "maven": { "artifactId": "s3", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.s3" }, "js": { "npm": "@aws-cdk/aws-s3" }, "python": { "distName": "aws-cdk.aws-s3", "module": "aws_cdk.aws_s3" } } }, "@aws-cdk/aws-s3-assets": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.S3.Assets", "packageId": "Amazon.CDK.AWS.S3.Assets", "signAssembly": true }, "java": { "maven": { "artifactId": "s3-assets", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.s3.assets" }, "js": { "npm": "@aws-cdk/aws-s3-assets" }, "python": { "distName": "aws-cdk.aws-s3-assets", "module": "aws_cdk.aws_s3_assets" } } }, "@aws-cdk/cloud-assembly-schema": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CloudAssembly.Schema", "packageId": "Amazon.CDK.CloudAssembly.Schema", "signAssembly": true }, "java": { "maven": { "artifactId": "cdk-cloud-assembly-schema", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cloudassembly.schema" }, "js": { "npm": "@aws-cdk/cloud-assembly-schema" }, "python": { "distName": "aws-cdk.cloud-assembly-schema", "module": "aws_cdk.cloud_assembly_schema" } } }, "@aws-cdk/core": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK", "packageId": "Amazon.CDK", "signAssembly": true }, "java": { "maven": { "artifactId": "core", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.core" }, "js": { "npm": "@aws-cdk/core" }, "python": { "distName": "aws-cdk.core", "module": "aws_cdk.core" } } }, "@aws-cdk/cx-api": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CXAPI", "packageId": "Amazon.CDK.CXAPI", "signAssembly": true }, "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" }, "python": { "distName": "aws-cdk.cx-api", "module": "aws_cdk.cx_api" } } }, "@aws-cdk/region-info": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.RegionInfo", "packageId": "Amazon.CDK.RegionInfo", "signAssembly": true }, "java": { "maven": { "artifactId": "cdk-region-info", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.regioninfo" }, "js": { "npm": "@aws-cdk/region-info" }, "python": { "distName": "aws-cdk.region-info", "module": "aws_cdk.region_info" } } }, "constructs": { "targets": { "dotnet": { "namespace": "Constructs", "packageId": "Constructs" }, "java": { "maven": { "artifactId": "constructs", "groupId": "software.constructs" }, "package": "software.constructs" }, "js": { "npm": "constructs" }, "python": { "distName": "constructs", "module": "constructs" } } } }, "description": "The CDK Construct Library for AWS::Logs", "docs": { "stability": "stable" }, "homepage": "https://github.com/aws/aws-cdk", "jsiiVersion": "1.12.0 (build 5ddc9f2)", "keywords": [ "aws", "cdk", "constructs", "logs" ], "license": "Apache-2.0", "name": "@aws-cdk/aws-logs", "readme": { "markdown": "## Amazon CloudWatch Logs Construct Library\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\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### 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\nconst fn = new lambda.Function(this, 'Lambda', { ... });\nconst logGroup = new LogGroup(this, 'LogGroup', { ... });\n\nnew SubscriptionFilter(this, 'Subscription', {\n logGroup,\n destination: new LogsDestinations.LambdaDestination(fn),\n filterPattern: 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\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\nconst mf = new MetricFilter(this, 'MetricFilter', {\n logGroup,\n metricNamespace: 'MyApp',\n metricName: 'Latency',\n filterPattern: 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 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.anyGroup([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\n\nExamples:\n\n```ts\n// Search for lines that contain both \"ERROR\" and \"MainThread\"\nconst pattern1 = FilterPattern.allTerms('ERROR', 'MainThread');\n\n// Search for lines that either contain both \"ERROR\" and \"MainThread\", or\n// both \"WARN\" and \"Deadlock\".\nconst pattern2 = FilterPattern.anyGroup(\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\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 = FilterPattern.all(\n FilterPattern.stringValue('$.component', '=', 'HttpServer'),\n FilterPattern.any(\n FilterPattern.booleanValue('$.error', true),\n FilterPattern.numberValue('$.latency', '>', 1000)\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 = FilterPattern.spaceDelimited('time', 'component', '...', 'result_code', 'latency')\n .whereString('component', '=', 'HttpServer')\n .whereNumber('result_code', '!=', 200);\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" }, "repository": { "directory": "packages/@aws-cdk/aws-logs", "type": "git", "url": "https://github.com/aws/aws-cdk.git" }, "schema": "jsii/0.10.0", "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Logs", "packageId": "Amazon.CDK.AWS.Logs", "signAssembly": true }, "java": { "maven": { "artifactId": "logs", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.logs" }, "js": { "npm": "@aws-cdk/aws-logs" }, "python": { "distName": "aws-cdk.aws-logs", "module": "aws_cdk.aws_logs" } }, "types": { "@aws-cdk/aws-logs.CfnDestination": { "assembly": "@aws-cdk/aws-logs", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Logs::Destination" }, "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html", "stability": "external", "summary": "A CloudFormation `AWS::Logs::Destination`." }, "fqn": "@aws-cdk/aws-logs.CfnDestination", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Logs::Destination`." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 160 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-logs.CfnDestinationProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/logs.generated.ts", "line": 102 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 181 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 194 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnDestination", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 106 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 127 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 186 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-destinationname", "stability": "external", "summary": "`AWS::Logs::Destination.DestinationName`." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 133 }, "name": "destinationName", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-destinationpolicy", "stability": "external", "summary": "`AWS::Logs::Destination.DestinationPolicy`." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 139 }, "name": "destinationPolicy", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-rolearn", "stability": "external", "summary": "`AWS::Logs::Destination.RoleArn`." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 145 }, "name": "roleArn", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-targetarn", "stability": "external", "summary": "`AWS::Logs::Destination.TargetArn`." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 151 }, "name": "targetArn", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-logs.CfnDestinationProps": { "assembly": "@aws-cdk/aws-logs", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html", "stability": "external", "summary": "Properties for defining a `AWS::Logs::Destination`." }, "fqn": "@aws-cdk/aws-logs.CfnDestinationProps", "kind": "interface", "locationInModule": { "filename": "lib/logs.generated.ts", "line": 17 }, "name": "CfnDestinationProps", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-destinationname", "stability": "external", "summary": "`AWS::Logs::Destination.DestinationName`." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 23 }, "name": "destinationName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-destinationpolicy", "stability": "external", "summary": "`AWS::Logs::Destination.DestinationPolicy`." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 29 }, "name": "destinationPolicy", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-rolearn", "stability": "external", "summary": "`AWS::Logs::Destination.RoleArn`." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 35 }, "name": "roleArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-targetarn", "stability": "external", "summary": "`AWS::Logs::Destination.TargetArn`." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 41 }, "name": "targetArn", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-logs.CfnLogGroup": { "assembly": "@aws-cdk/aws-logs", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Logs::LogGroup" }, "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html", "stability": "external", "summary": "A CloudFormation `AWS::Logs::LogGroup`." }, "fqn": "@aws-cdk/aws-logs.CfnLogGroup", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Logs::LogGroup`." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 314 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-logs.CfnLogGroupProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/logs.generated.ts", "line": 268 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 329 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 340 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnLogGroup", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 272 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 293 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 334 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-cwl-loggroup-loggroupname", "stability": "external", "summary": "`AWS::Logs::LogGroup.LogGroupName`." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 299 }, "name": "logGroupName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-cwl-loggroup-retentionindays", "stability": "external", "summary": "`AWS::Logs::LogGroup.RetentionInDays`." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 305 }, "name": "retentionInDays", "optional": true, "type": { "primitive": "number" } } ] }, "@aws-cdk/aws-logs.CfnLogGroupProps": { "assembly": "@aws-cdk/aws-logs", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html", "stability": "external", "summary": "Properties for defining a `AWS::Logs::LogGroup`." }, "fqn": "@aws-cdk/aws-logs.CfnLogGroupProps", "kind": "interface", "locationInModule": { "filename": "lib/logs.generated.ts", "line": 205 }, "name": "CfnLogGroupProps", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-cwl-loggroup-loggroupname", "stability": "external", "summary": "`AWS::Logs::LogGroup.LogGroupName`." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 211 }, "name": "logGroupName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-cwl-loggroup-retentionindays", "stability": "external", "summary": "`AWS::Logs::LogGroup.RetentionInDays`." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 217 }, "name": "retentionInDays", "optional": true, "type": { "primitive": "number" } } ] }, "@aws-cdk/aws-logs.CfnLogStream": { "assembly": "@aws-cdk/aws-logs", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Logs::LogStream" }, "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html", "stability": "external", "summary": "A CloudFormation `AWS::Logs::LogStream`." }, "fqn": "@aws-cdk/aws-logs.CfnLogStream", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Logs::LogStream`." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 456 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-logs.CfnLogStreamProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/logs.generated.ts", "line": 415 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 471 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 482 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnLogStream", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 419 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 476 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html#cfn-logs-logstream-loggroupname", "stability": "external", "summary": "`AWS::Logs::LogStream.LogGroupName`." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 441 }, "name": "logGroupName", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html#cfn-logs-logstream-logstreamname", "stability": "external", "summary": "`AWS::Logs::LogStream.LogStreamName`." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 447 }, "name": "logStreamName", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-logs.CfnLogStreamProps": { "assembly": "@aws-cdk/aws-logs", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html", "stability": "external", "summary": "Properties for defining a `AWS::Logs::LogStream`." }, "fqn": "@aws-cdk/aws-logs.CfnLogStreamProps", "kind": "interface", "locationInModule": { "filename": "lib/logs.generated.ts", "line": 351 }, "name": "CfnLogStreamProps", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html#cfn-logs-logstream-loggroupname", "stability": "external", "summary": "`AWS::Logs::LogStream.LogGroupName`." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 357 }, "name": "logGroupName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html#cfn-logs-logstream-logstreamname", "stability": "external", "summary": "`AWS::Logs::LogStream.LogStreamName`." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 363 }, "name": "logStreamName", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-logs.CfnMetricFilter": { "assembly": "@aws-cdk/aws-logs", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Logs::MetricFilter" }, "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html", "stability": "external", "summary": "A CloudFormation `AWS::Logs::MetricFilter`." }, "fqn": "@aws-cdk/aws-logs.CfnMetricFilter", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Logs::MetricFilter`." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 615 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-logs.CfnMetricFilterProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/logs.generated.ts", "line": 568 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 633 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 645 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnMetricFilter", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 572 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 638 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-cwl-metricfilter-filterpattern", "stability": "external", "summary": "`AWS::Logs::MetricFilter.FilterPattern`." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 594 }, "name": "filterPattern", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-cwl-metricfilter-loggroupname", "stability": "external", "summary": "`AWS::Logs::MetricFilter.LogGroupName`." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 600 }, "name": "logGroupName", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-cwl-metricfilter-metrictransformations", "stability": "external", "summary": "`AWS::Logs::MetricFilter.MetricTransformations`." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 606 }, "name": "metricTransformations", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/aws-logs.CfnMetricFilter.MetricTransformationProperty" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } }, "kind": "array" } } ] } } } ] }, "@aws-cdk/aws-logs.CfnMetricFilter.MetricTransformationProperty": { "assembly": "@aws-cdk/aws-logs", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html", "stability": "external" }, "fqn": "@aws-cdk/aws-logs.CfnMetricFilter.MetricTransformationProperty", "kind": "interface", "locationInModule": { "filename": "lib/logs.generated.ts", "line": 655 }, "name": "MetricTransformationProperty", "namespace": "CfnMetricFilter", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-cwl-metricfilter-metrictransformation-metricname", "stability": "external", "summary": "`CfnMetricFilter.MetricTransformationProperty.MetricName`." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 665 }, "name": "metricName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-cwl-metricfilter-metrictransformation-metricnamespace", "stability": "external", "summary": "`CfnMetricFilter.MetricTransformationProperty.MetricNamespace`." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 670 }, "name": "metricNamespace", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-cwl-metricfilter-metrictransformation-metricvalue", "stability": "external", "summary": "`CfnMetricFilter.MetricTransformationProperty.MetricValue`." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 675 }, "name": "metricValue", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-cwl-metricfilter-metrictransformation-defaultvalue", "stability": "external", "summary": "`CfnMetricFilter.MetricTransformationProperty.DefaultValue`." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 660 }, "name": "defaultValue", "optional": true, "type": { "primitive": "number" } } ] }, "@aws-cdk/aws-logs.CfnMetricFilterProps": { "assembly": "@aws-cdk/aws-logs", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html", "stability": "external", "summary": "Properties for defining a `AWS::Logs::MetricFilter`." }, "fqn": "@aws-cdk/aws-logs.CfnMetricFilterProps", "kind": "interface", "locationInModule": { "filename": "lib/logs.generated.ts", "line": 493 }, "name": "CfnMetricFilterProps", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-cwl-metricfilter-filterpattern", "stability": "external", "summary": "`AWS::Logs::MetricFilter.FilterPattern`." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 499 }, "name": "filterPattern", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-cwl-metricfilter-loggroupname", "stability": "external", "summary": "`AWS::Logs::MetricFilter.LogGroupName`." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 505 }, "name": "logGroupName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-cwl-metricfilter-metrictransformations", "stability": "external", "summary": "`AWS::Logs::MetricFilter.MetricTransformations`." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 511 }, "name": "metricTransformations", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/aws-logs.CfnMetricFilter.MetricTransformationProperty" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } }, "kind": "array" } } ] } } } ] }, "@aws-cdk/aws-logs.CfnSubscriptionFilter": { "assembly": "@aws-cdk/aws-logs", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Logs::SubscriptionFilter" }, "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html", "stability": "external", "summary": "A CloudFormation `AWS::Logs::SubscriptionFilter`." }, "fqn": "@aws-cdk/aws-logs.CfnSubscriptionFilter", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Logs::SubscriptionFilter`." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 875 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-logs.CfnSubscriptionFilterProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/logs.generated.ts", "line": 822 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 894 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 907 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnSubscriptionFilter", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 826 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 899 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-destinationarn", "stability": "external", "summary": "`AWS::Logs::SubscriptionFilter.DestinationArn`." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 848 }, "name": "destinationArn", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-filterpattern", "stability": "external", "summary": "`AWS::Logs::SubscriptionFilter.FilterPattern`." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 854 }, "name": "filterPattern", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-loggroupname", "stability": "external", "summary": "`AWS::Logs::SubscriptionFilter.LogGroupName`." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 860 }, "name": "logGroupName", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-rolearn", "stability": "external", "summary": "`AWS::Logs::SubscriptionFilter.RoleArn`." }, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 866 }, "name": "roleArn", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-logs.CfnSubscriptionFilterProps": { "assembly": "@aws-cdk/aws-logs", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html", "stability": "external", "summary": "Properties for defining a `AWS::Logs::SubscriptionFilter`." }, "fqn": "@aws-cdk/aws-logs.CfnSubscriptionFilterProps", "kind": "interface", "locationInModule": { "filename": "lib/logs.generated.ts", "line": 738 }, "name": "CfnSubscriptionFilterProps", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-destinationarn", "stability": "external", "summary": "`AWS::Logs::SubscriptionFilter.DestinationArn`." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 744 }, "name": "destinationArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-filterpattern", "stability": "external", "summary": "`AWS::Logs::SubscriptionFilter.FilterPattern`." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 750 }, "name": "filterPattern", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-loggroupname", "stability": "external", "summary": "`AWS::Logs::SubscriptionFilter.LogGroupName`." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 756 }, "name": "logGroupName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-rolearn", "stability": "external", "summary": "`AWS::Logs::SubscriptionFilter.RoleArn`." }, "immutable": true, "locationInModule": { "filename": "lib/logs.generated.ts", "line": 762 }, "name": "roleArn", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-logs.ColumnRestriction": { "assembly": "@aws-cdk/aws-logs", "datatype": true, "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-logs.ColumnRestriction", "kind": "interface", "locationInModule": { "filename": "lib/pattern.ts", "line": 369 }, "name": "ColumnRestriction", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Comparison operator to use." }, "immutable": true, "locationInModule": { "filename": "lib/pattern.ts", "line": 373 }, "name": "comparison", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Exactly one of 'stringValue' and 'numberValue' must be set.", "stability": "stable", "summary": "Number value to compare to." }, "immutable": true, "locationInModule": { "filename": "lib/pattern.ts", "line": 387 }, "name": "numberValue", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "remarks": "Exactly one of 'stringValue' and 'numberValue' must be set.", "stability": "stable", "summary": "String value to compare to." }, "immutable": true, "locationInModule": { "filename": "lib/pattern.ts", "line": 380 }, "name": "stringValue", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-logs.CrossAccountDestination": { "assembly": "@aws-cdk/aws-logs", "base": "@aws-cdk/core.Resource", "docs": { "custom": { "resource": "AWS::Logs::Destination" }, "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.", "stability": "stable", "summary": "A new CloudWatch Logs Destination for use in cross-account scenarios." }, "fqn": "@aws-cdk/aws-logs.CrossAccountDestination", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/cross-account-destination.ts", "line": 67 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-logs.CrossAccountDestinationProps" } } ] }, "interfaces": [ "@aws-cdk/aws-logs.ILogSubscriptionDestination" ], "kind": "class", "locationInModule": { "filename": "lib/cross-account-destination.ts", "line": 44 }, "methods": [ { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/cross-account-destination.ts", "line": 91 }, "name": "addToPolicy", "parameters": [ { "name": "statement", "type": { "fqn": "@aws-cdk/aws-iam.PolicyStatement" } } ] }, { "docs": { "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.", "stability": "stable", "summary": "Return the properties required to send subscription events to this destination." }, "locationInModule": { "filename": "lib/cross-account-destination.ts", "line": 95 }, "name": "bind", "overrides": "@aws-cdk/aws-logs.ILogSubscriptionDestination", "parameters": [ { "name": "_scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "_sourceLogGroup", "type": { "fqn": "@aws-cdk/aws-logs.ILogGroup" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.LogSubscriptionDestinationConfig" } } } ], "name": "CrossAccountDestination", "properties": [ { "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The ARN of this CrossAccountDestination object." }, "immutable": true, "locationInModule": { "filename": "lib/cross-account-destination.ts", "line": 60 }, "name": "destinationArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The name of this CrossAccountDestination object." }, "immutable": true, "locationInModule": { "filename": "lib/cross-account-destination.ts", "line": 54 }, "name": "destinationName", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Policy object of this CrossAccountDestination object." }, "immutable": true, "locationInModule": { "filename": "lib/cross-account-destination.ts", "line": 48 }, "name": "policyDocument", "type": { "fqn": "@aws-cdk/aws-iam.PolicyDocument" } } ] }, "@aws-cdk/aws-logs.CrossAccountDestinationProps": { "assembly": "@aws-cdk/aws-logs", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for a CrossAccountDestination." }, "fqn": "@aws-cdk/aws-logs.CrossAccountDestinationProps", "kind": "interface", "locationInModule": { "filename": "lib/cross-account-destination.ts", "line": 10 }, "name": "CrossAccountDestinationProps", "properties": [ { "abstract": true, "docs": { "remarks": "The role must be assumable by 'logs.{REGION}.amazonaws.com'.", "stability": "stable", "summary": "The role to assume that grants permissions to write to 'target'." }, "immutable": true, "locationInModule": { "filename": "lib/cross-account-destination.ts", "line": 23 }, "name": "role", "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The log destination target's ARN." }, "immutable": true, "locationInModule": { "filename": "lib/cross-account-destination.ts", "line": 28 }, "name": "targetArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "Automatically generated", "stability": "stable", "summary": "The name of the log destination." }, "immutable": true, "locationInModule": { "filename": "lib/cross-account-destination.ts", "line": 16 }, "name": "destinationName", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-logs.FilterPattern": { "assembly": "@aws-cdk/aws-logs", "docs": { "stability": "stable", "summary": "A collection of static methods to generate appropriate ILogPatterns." }, "fqn": "@aws-cdk/aws-logs.FilterPattern", "initializer": { "docs": { "stability": "stable" } }, "kind": "class", "locationInModule": { "filename": "lib/pattern.ts", "line": 26 }, "methods": [ { "docs": { "stability": "stable", "summary": "A JSON log pattern that matches if all given JSON log patterns match." }, "locationInModule": { "filename": "lib/pattern.ts", "line": 162 }, "name": "all", "parameters": [ { "name": "patterns", "type": { "fqn": "@aws-cdk/aws-logs.JsonPattern" }, "variadic": true } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.JsonPattern" } }, "static": true, "variadic": true }, { "docs": { "stability": "stable", "summary": "A log pattern that matches all events." }, "locationInModule": { "filename": "lib/pattern.ts", "line": 43 }, "name": "allEvents", "returns": { "type": { "fqn": "@aws-cdk/aws-logs.IFilterPattern" } }, "static": true }, { "docs": { "stability": "stable", "summary": "A log pattern that matches if all the strings given appear in the event." }, "locationInModule": { "filename": "lib/pattern.ts", "line": 52 }, "name": "allTerms", "parameters": [ { "docs": { "remarks": "All terms must match.", "summary": "The words to search for." }, "name": "terms", "type": { "primitive": "string" }, "variadic": true } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.IFilterPattern" } }, "static": true, "variadic": true }, { "docs": { "stability": "stable", "summary": "A JSON log pattern that matches if any of the given JSON log patterns match." }, "locationInModule": { "filename": "lib/pattern.ts", "line": 171 }, "name": "any", "parameters": [ { "name": "patterns", "type": { "fqn": "@aws-cdk/aws-logs.JsonPattern" }, "variadic": true } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.JsonPattern" } }, "static": true, "variadic": true }, { "docs": { "stability": "stable", "summary": "A log pattern that matches if any of the strings given appear in the event." }, "locationInModule": { "filename": "lib/pattern.ts", "line": 61 }, "name": "anyTerm", "parameters": [ { "docs": { "remarks": "Any terms must match.", "summary": "The words to search for." }, "name": "terms", "type": { "primitive": "string" }, "variadic": true } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.IFilterPattern" } }, "static": true, "variadic": true }, { "docs": { "remarks": "A term group matches an event if all the terms in it appear in the event string.", "stability": "stable", "summary": "A log pattern that matches if any of the given term groups matches the event." }, "locationInModule": { "filename": "lib/pattern.ts", "line": 72 }, "name": "anyTermGroup", "parameters": [ { "docs": { "remarks": "Any one of the clauses must match.", "summary": "A list of term groups to search for." }, "name": "termGroups", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } }, "variadic": true } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.IFilterPattern" } }, "static": true, "variadic": true }, { "docs": { "stability": "stable", "summary": "A JSON log pattern that matches if the field exists and equals the boolean value." }, "locationInModule": { "filename": "lib/pattern.ts", "line": 155 }, "name": "booleanValue", "parameters": [ { "docs": { "remarks": "Example: \"$.myField\"", "summary": "Field inside JSON." }, "name": "jsonField", "type": { "primitive": "string" } }, { "docs": { "summary": "The value to match." }, "name": "value", "type": { "primitive": "boolean" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.JsonPattern" } }, "static": true }, { "docs": { "remarks": "This is a readable convenience wrapper over 'field = *'", "stability": "stable", "summary": "A JSON log patter that matches if the field exists." }, "locationInModule": { "filename": "lib/pattern.ts", "line": 145 }, "name": "exists", "parameters": [ { "docs": { "remarks": "Example: \"$.myField\"", "summary": "Field inside JSON." }, "name": "jsonField", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.JsonPattern" } }, "static": true }, { "docs": { "stability": "stable", "summary": "A JSON log pattern that matches if the field exists and has the special value 'null'." }, "locationInModule": { "filename": "lib/pattern.ts", "line": 125 }, "name": "isNull", "parameters": [ { "docs": { "remarks": "Example: \"$.myField\"", "summary": "Field inside JSON." }, "name": "jsonField", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.JsonPattern" } }, "static": true }, { "docs": { "remarks": "See https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html\nfor information on writing log patterns.", "stability": "stable", "summary": "Use the given string as log pattern." }, "locationInModule": { "filename": "lib/pattern.ts", "line": 36 }, "name": "literal", "parameters": [ { "docs": { "summary": "The pattern string to use." }, "name": "logPatternString", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.IFilterPattern" } }, "static": true }, { "docs": { "stability": "stable", "summary": "A JSON log pattern that matches if the field does not exist." }, "locationInModule": { "filename": "lib/pattern.ts", "line": 134 }, "name": "notExists", "parameters": [ { "docs": { "remarks": "Example: \"$.myField\"", "summary": "Field inside JSON." }, "name": "jsonField", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.JsonPattern" } }, "static": true }, { "docs": { "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", "stability": "stable", "summary": "A JSON log pattern that compares numerical values." }, "locationInModule": { "filename": "lib/pattern.ts", "line": 116 }, "name": "numberValue", "parameters": [ { "docs": { "remarks": "Example: \"$.myField\"", "summary": "Field inside JSON." }, "name": "jsonField", "type": { "primitive": "string" } }, { "docs": { "remarks": "One of =, !=, <, <=, >, >=.", "summary": "Comparison to carry out." }, "name": "comparison", "type": { "primitive": "string" } }, { "docs": { "summary": "The numerical value to compare to." }, "name": "value", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.JsonPattern" } }, "static": true }, { "docs": { "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.", "stability": "stable", "summary": "A space delimited log pattern matcher." }, "locationInModule": { "filename": "lib/pattern.ts", "line": 190 }, "name": "spaceDelimited", "parameters": [ { "docs": { "summary": "The columns in the space-delimited log stream." }, "name": "columns", "type": { "primitive": "string" }, "variadic": true } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.SpaceDelimitedTextPattern" } }, "static": true, "variadic": true }, { "docs": { "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", "stability": "stable", "summary": "A JSON log pattern that compares string values." }, "locationInModule": { "filename": "lib/pattern.ts", "line": 94 }, "name": "stringValue", "parameters": [ { "docs": { "remarks": "Example: \"$.myField\"", "summary": "Field inside JSON." }, "name": "jsonField", "type": { "primitive": "string" } }, { "docs": { "remarks": "Either = or !=.", "summary": "Comparison to carry out." }, "name": "comparison", "type": { "primitive": "string" } }, { "docs": { "remarks": "May use '*' as wildcard at start or end of string.", "summary": "The string value to compare to." }, "name": "value", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.JsonPattern" } }, "static": true } ], "name": "FilterPattern" }, "@aws-cdk/aws-logs.IFilterPattern": { "assembly": "@aws-cdk/aws-logs", "docs": { "stability": "stable", "summary": "Interface for objects that can render themselves to log patterns." }, "fqn": "@aws-cdk/aws-logs.IFilterPattern", "kind": "interface", "locationInModule": { "filename": "lib/pattern.ts", "line": 6 }, "name": "IFilterPattern", "properties": [ { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/pattern.ts", "line": 7 }, "name": "logPatternString", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-logs.ILogGroup": { "assembly": "@aws-cdk/aws-logs", "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-logs.ILogGroup", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/log-group.ts", "line": 10 }, "methods": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Create a new Metric Filter on this Log Group." }, "locationInModule": { "filename": "lib/log-group.ts", "line": 46 }, "name": "addMetricFilter", "parameters": [ { "docs": { "summary": "Unique identifier for the construct in its parent." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "Properties for creating the MetricFilter." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-logs.MetricFilterOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.MetricFilter" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Create a new Log Stream for this Log Group." }, "locationInModule": { "filename": "lib/log-group.ts", "line": 30 }, "name": "addStream", "parameters": [ { "docs": { "summary": "Unique identifier for the construct in its parent." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "Properties for creating the LogStream." }, "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-logs.StreamOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.LogStream" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Create a new Subscription Filter on this Log Group." }, "locationInModule": { "filename": "lib/log-group.ts", "line": 38 }, "name": "addSubscriptionFilter", "parameters": [ { "docs": { "summary": "Unique identifier for the construct in its parent." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "Properties for creating the SubscriptionFilter." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-logs.SubscriptionFilterOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.SubscriptionFilter" } } }, { "abstract": true, "docs": { "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.", "returns": "A Metric object representing the extracted metric", "stability": "stable", "summary": "Extract a metric from structured log events in the LogGroup." }, "locationInModule": { "filename": "lib/log-group.ts", "line": 62 }, "name": "extractMetric", "parameters": [ { "docs": { "summary": "JSON field to extract (example: '$.myfield')." }, "name": "jsonField", "type": { "primitive": "string" } }, { "docs": { "summary": "Namespace to emit the metric under." }, "name": "metricNamespace", "type": { "primitive": "string" } }, { "docs": { "summary": "Name to emit the metric under." }, "name": "metricName", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Give the indicated permissions on this log group and all streams." }, "locationInModule": { "filename": "lib/log-group.ts", "line": 72 }, "name": "grant", "parameters": [ { "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } }, { "name": "actions", "type": { "primitive": "string" }, "variadic": true } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } }, "variadic": true }, { "abstract": true, "docs": { "stability": "stable", "summary": "Give permissions to write to create and write to streams in this log group." }, "locationInModule": { "filename": "lib/log-group.ts", "line": 67 }, "name": "grantWrite", "parameters": [ { "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } } ], "name": "ILogGroup", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The ARN of this log group, with ':*' appended." }, "immutable": true, "locationInModule": { "filename": "lib/log-group.ts", "line": 16 }, "name": "logGroupArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The name of this log group." }, "immutable": true, "locationInModule": { "filename": "lib/log-group.ts", "line": 22 }, "name": "logGroupName", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-logs.ILogStream": { "assembly": "@aws-cdk/aws-logs", "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-logs.ILogStream", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/log-stream.ts", "line": 5 }, "name": "ILogStream", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The name of this log stream." }, "immutable": true, "locationInModule": { "filename": "lib/log-stream.ts", "line": 10 }, "name": "logStreamName", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-logs.ILogSubscriptionDestination": { "assembly": "@aws-cdk/aws-logs", "docs": { "stability": "stable", "summary": "Interface for classes that can be the destination of a log Subscription." }, "fqn": "@aws-cdk/aws-logs.ILogSubscriptionDestination", "kind": "interface", "locationInModule": { "filename": "lib/subscription-filter.ts", "line": 9 }, "methods": [ { "abstract": true, "docs": { "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.", "stability": "stable", "summary": "Return the properties required to send subscription events to this destination." }, "locationInModule": { "filename": "lib/subscription-filter.ts", "line": 20 }, "name": "bind", "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "sourceLogGroup", "type": { "fqn": "@aws-cdk/aws-logs.ILogGroup" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.LogSubscriptionDestinationConfig" } } } ], "name": "ILogSubscriptionDestination" }, "@aws-cdk/aws-logs.JsonPattern": { "abstract": true, "assembly": "@aws-cdk/aws-logs", "docs": { "stability": "stable", "summary": "Base class for patterns that only match JSON log events." }, "fqn": "@aws-cdk/aws-logs.JsonPattern", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/pattern.ts", "line": 16 }, "parameters": [ { "name": "jsonPatternString", "type": { "primitive": "string" } } ] }, "interfaces": [ "@aws-cdk/aws-logs.IFilterPattern" ], "kind": "class", "locationInModule": { "filename": "lib/pattern.ts", "line": 13 }, "name": "JsonPattern", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/pattern.ts", "line": 16 }, "name": "jsonPatternString", "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/pattern.ts", "line": 18 }, "name": "logPatternString", "overrides": "@aws-cdk/aws-logs.IFilterPattern", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-logs.LogGroup": { "assembly": "@aws-cdk/aws-logs", "base": "@aws-cdk/core.Resource", "docs": { "stability": "stable", "summary": "Define a CloudWatch Log Group." }, "fqn": "@aws-cdk/aws-logs.LogGroup", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/log-group.ts", "line": 351 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-logs.LogGroupProps" } } ] }, "interfaces": [ "@aws-cdk/aws-logs.ILogGroup" ], "kind": "class", "locationInModule": { "filename": "lib/log-group.ts", "line": 307 }, "methods": [ { "docs": { "stability": "stable", "summary": "Import an existing LogGroup given its ARN." }, "locationInModule": { "filename": "lib/log-group.ts", "line": 311 }, "name": "fromLogGroupArn", "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "logGroupArn", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.ILogGroup" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Import an existing LogGroup given its name." }, "locationInModule": { "filename": "lib/log-group.ts", "line": 325 }, "name": "fromLogGroupName", "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "logGroupName", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.ILogGroup" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Create a new Metric Filter on this Log Group." }, "locationInModule": { "filename": "lib/log-group.ts", "line": 121 }, "name": "addMetricFilter", "overrides": "@aws-cdk/aws-logs.ILogGroup", "parameters": [ { "docs": { "summary": "Unique identifier for the construct in its parent." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "Properties for creating the MetricFilter." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-logs.MetricFilterOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.MetricFilter" } } }, { "docs": { "stability": "stable", "summary": "Create a new Log Stream for this Log Group." }, "locationInModule": { "filename": "lib/log-group.ts", "line": 95 }, "name": "addStream", "overrides": "@aws-cdk/aws-logs.ILogGroup", "parameters": [ { "docs": { "summary": "Unique identifier for the construct in its parent." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "Properties for creating the LogStream." }, "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-logs.StreamOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.LogStream" } } }, { "docs": { "stability": "stable", "summary": "Create a new Subscription Filter on this Log Group." }, "locationInModule": { "filename": "lib/log-group.ts", "line": 108 }, "name": "addSubscriptionFilter", "overrides": "@aws-cdk/aws-logs.ILogGroup", "parameters": [ { "docs": { "summary": "Unique identifier for the construct in its parent." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "Properties for creating the SubscriptionFilter." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-logs.SubscriptionFilterOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.SubscriptionFilter" } } }, { "docs": { "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.", "returns": "A Metric object representing the extracted metric", "stability": "stable", "summary": "Extract a metric from structured log events in the LogGroup." }, "locationInModule": { "filename": "lib/log-group.ts", "line": 142 }, "name": "extractMetric", "overrides": "@aws-cdk/aws-logs.ILogGroup", "parameters": [ { "docs": { "summary": "JSON field to extract (example: '$.myfield')." }, "name": "jsonField", "type": { "primitive": "string" } }, { "docs": { "summary": "Namespace to emit the metric under." }, "name": "metricNamespace", "type": { "primitive": "string" } }, { "docs": { "summary": "Name to emit the metric under." }, "name": "metricName", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "stability": "stable", "summary": "Give the indicated permissions on this log group and all streams." }, "locationInModule": { "filename": "lib/log-group.ts", "line": 164 }, "name": "grant", "overrides": "@aws-cdk/aws-logs.ILogGroup", "parameters": [ { "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } }, { "name": "actions", "type": { "primitive": "string" }, "variadic": true } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } }, "variadic": true }, { "docs": { "stability": "stable", "summary": "Give permissions to write to create and write to streams in this log group." }, "locationInModule": { "filename": "lib/log-group.ts", "line": 157 }, "name": "grantWrite", "overrides": "@aws-cdk/aws-logs.ILogGroup", "parameters": [ { "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } } ], "name": "LogGroup", "properties": [ { "docs": { "stability": "stable", "summary": "The ARN of this log group." }, "immutable": true, "locationInModule": { "filename": "lib/log-group.ts", "line": 344 }, "name": "logGroupArn", "overrides": "@aws-cdk/aws-logs.ILogGroup", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The name of this log group." }, "immutable": true, "locationInModule": { "filename": "lib/log-group.ts", "line": 349 }, "name": "logGroupName", "overrides": "@aws-cdk/aws-logs.ILogGroup", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-logs.LogGroupProps": { "assembly": "@aws-cdk/aws-logs", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for a LogGroup." }, "fqn": "@aws-cdk/aws-logs.LogGroupProps", "kind": "interface", "locationInModule": { "filename": "lib/log-group.ts", "line": 274 }, "name": "LogGroupProps", "properties": [ { "abstract": true, "docs": { "default": "Automatically generated", "stability": "stable", "summary": "Name of the log group." }, "immutable": true, "locationInModule": { "filename": "lib/log-group.ts", "line": 280 }, "name": "logGroupName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "RemovalPolicy.Retain", "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.", "stability": "stable", "summary": "Determine the removal policy of this log group." }, "immutable": true, "locationInModule": { "filename": "lib/log-group.ts", "line": 301 }, "name": "removalPolicy", "optional": true, "type": { "fqn": "@aws-cdk/core.RemovalPolicy" } }, { "abstract": true, "docs": { "default": "RetentionDays.TWO_YEARS", "remarks": "To retain all logs, set this value to RetentionDays.INFINITE.", "stability": "stable", "summary": "How long, in days, the log contents will be retained." }, "immutable": true, "locationInModule": { "filename": "lib/log-group.ts", "line": 289 }, "name": "retention", "optional": true, "type": { "fqn": "@aws-cdk/aws-logs.RetentionDays" } } ] }, "@aws-cdk/aws-logs.LogRetention": { "assembly": "@aws-cdk/aws-logs", "base": "@aws-cdk/core.Construct", "docs": { "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`", "stability": "stable", "summary": "Creates a custom resource to control the retention policy of a CloudWatch Logs log group." }, "fqn": "@aws-cdk/aws-logs.LogRetention", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/log-retention.ts", "line": 74 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-logs.LogRetentionProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/log-retention.ts", "line": 67 }, "name": "LogRetention", "properties": [ { "docs": { "stability": "stable", "summary": "The ARN of the LogGroup." }, "immutable": true, "locationInModule": { "filename": "lib/log-retention.ts", "line": 72 }, "name": "logGroupArn", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-logs.LogRetentionProps": { "assembly": "@aws-cdk/aws-logs", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a LogRetention." }, "fqn": "@aws-cdk/aws-logs.LogRetentionProps", "kind": "interface", "locationInModule": { "filename": "lib/log-retention.ts", "line": 10 }, "name": "LogRetentionProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The log group name." }, "immutable": true, "locationInModule": { "filename": "lib/log-retention.ts", "line": 14 }, "name": "logGroupName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The number of days log events are kept in CloudWatch Logs." }, "immutable": true, "locationInModule": { "filename": "lib/log-retention.ts", "line": 25 }, "name": "retention", "type": { "fqn": "@aws-cdk/aws-logs.RetentionDays" } }, { "abstract": true, "docs": { "default": "- same region as the stack", "stability": "stable", "summary": "The region where the log group should be created." }, "immutable": true, "locationInModule": { "filename": "lib/log-retention.ts", "line": 20 }, "name": "logGroupRegion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- AWS SDK default retry options", "stability": "stable", "summary": "Retry options for all AWS API calls." }, "immutable": true, "locationInModule": { "filename": "lib/log-retention.ts", "line": 39 }, "name": "logRetentionRetryOptions", "optional": true, "type": { "fqn": "@aws-cdk/aws-logs.LogRetentionRetryOptions" } }, { "abstract": true, "docs": { "default": "- A new role is created", "stability": "stable", "summary": "The IAM role for the Lambda function associated with the custom resource." }, "immutable": true, "locationInModule": { "filename": "lib/log-retention.ts", "line": 32 }, "name": "role", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } } ] }, "@aws-cdk/aws-logs.LogRetentionRetryOptions": { "assembly": "@aws-cdk/aws-logs", "datatype": true, "docs": { "stability": "stable", "summary": "Retry options for all AWS API calls." }, "fqn": "@aws-cdk/aws-logs.LogRetentionRetryOptions", "kind": "interface", "locationInModule": { "filename": "lib/log-retention.ts", "line": 45 }, "name": "LogRetentionRetryOptions", "properties": [ { "abstract": true, "docs": { "default": "Duration.millis(100) (AWS SDK default)", "stability": "stable", "summary": "The base duration to use in the exponential backoff for operation retries." }, "immutable": true, "locationInModule": { "filename": "lib/log-retention.ts", "line": 57 }, "name": "base", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "default": "3 (AWS SDK default)", "stability": "stable", "summary": "The maximum amount of retries." }, "immutable": true, "locationInModule": { "filename": "lib/log-retention.ts", "line": 51 }, "name": "maxRetries", "optional": true, "type": { "primitive": "number" } } ] }, "@aws-cdk/aws-logs.LogStream": { "assembly": "@aws-cdk/aws-logs", "base": "@aws-cdk/core.Resource", "docs": { "stability": "stable", "summary": "Define a Log Stream in a Log Group." }, "fqn": "@aws-cdk/aws-logs.LogStream", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/log-stream.ts", "line": 66 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-logs.LogStreamProps" } } ] }, "interfaces": [ "@aws-cdk/aws-logs.ILogStream" ], "kind": "class", "locationInModule": { "filename": "lib/log-stream.ts", "line": 49 }, "methods": [ { "docs": { "stability": "stable", "summary": "Import an existing LogGroup." }, "locationInModule": { "filename": "lib/log-stream.ts", "line": 53 }, "name": "fromLogStreamName", "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "logStreamName", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.ILogStream" } }, "static": true } ], "name": "LogStream", "properties": [ { "docs": { "stability": "stable", "summary": "The name of this log stream." }, "immutable": true, "locationInModule": { "filename": "lib/log-stream.ts", "line": 64 }, "name": "logStreamName", "overrides": "@aws-cdk/aws-logs.ILogStream", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-logs.LogStreamProps": { "assembly": "@aws-cdk/aws-logs", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for a LogStream." }, "fqn": "@aws-cdk/aws-logs.LogStreamProps", "kind": "interface", "locationInModule": { "filename": "lib/log-stream.ts", "line": 16 }, "name": "LogStreamProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The log group to create a log stream for." }, "immutable": true, "locationInModule": { "filename": "lib/log-stream.ts", "line": 20 }, "name": "logGroup", "type": { "fqn": "@aws-cdk/aws-logs.ILogGroup" } }, { "abstract": true, "docs": { "default": "Automatically generated", "remarks": "The name must be unique within the log group.", "stability": "stable", "summary": "The name of the log stream to create." }, "immutable": true, "locationInModule": { "filename": "lib/log-stream.ts", "line": 29 }, "name": "logStreamName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "RemovalPolicy.Retain", "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.", "stability": "stable", "summary": "Determine what happens when the log stream resource is removed from the app." }, "immutable": true, "locationInModule": { "filename": "lib/log-stream.ts", "line": 43 }, "name": "removalPolicy", "optional": true, "type": { "fqn": "@aws-cdk/core.RemovalPolicy" } } ] }, "@aws-cdk/aws-logs.LogSubscriptionDestinationConfig": { "assembly": "@aws-cdk/aws-logs", "datatype": true, "docs": { "stability": "stable", "summary": "Properties returned by a Subscription destination." }, "fqn": "@aws-cdk/aws-logs.LogSubscriptionDestinationConfig", "kind": "interface", "locationInModule": { "filename": "lib/subscription-filter.ts", "line": 26 }, "name": "LogSubscriptionDestinationConfig", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The ARN of the subscription's destination." }, "immutable": true, "locationInModule": { "filename": "lib/subscription-filter.ts", "line": 30 }, "name": "arn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "No role assumed", "stability": "stable", "summary": "The role to assume to write log events to the destination." }, "immutable": true, "locationInModule": { "filename": "lib/subscription-filter.ts", "line": 37 }, "name": "role", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } } ] }, "@aws-cdk/aws-logs.MetricFilter": { "assembly": "@aws-cdk/aws-logs", "base": "@aws-cdk/core.Resource", "docs": { "stability": "stable", "summary": "A filter that extracts information from CloudWatch Logs and emits to CloudWatch Metrics." }, "fqn": "@aws-cdk/aws-logs.MetricFilter", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/metric-filter.ts", "line": 24 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-logs.MetricFilterProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/metric-filter.ts", "line": 19 }, "methods": [ { "docs": { "default": "avg over 5 minutes", "stability": "stable", "summary": "Return the given named metric for this Metric Filter." }, "locationInModule": { "filename": "lib/metric-filter.ts", "line": 55 }, "name": "metric", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } } ], "name": "MetricFilter" }, "@aws-cdk/aws-logs.MetricFilterOptions": { "assembly": "@aws-cdk/aws-logs", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for a MetricFilter created from a LogGroup." }, "fqn": "@aws-cdk/aws-logs.MetricFilterOptions", "kind": "interface", "locationInModule": { "filename": "lib/log-group.ts", "line": 415 }, "name": "MetricFilterOptions", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Pattern to search for log events." }, "immutable": true, "locationInModule": { "filename": "lib/log-group.ts", "line": 419 }, "name": "filterPattern", "type": { "fqn": "@aws-cdk/aws-logs.IFilterPattern" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The name of the metric to emit." }, "immutable": true, "locationInModule": { "filename": "lib/log-group.ts", "line": 429 }, "name": "metricName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The namespace of the metric to emit." }, "immutable": true, "locationInModule": { "filename": "lib/log-group.ts", "line": 424 }, "name": "metricNamespace", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "No metric emitted.", "stability": "stable", "summary": "The value to emit if the pattern does not match a particular event." }, "immutable": true, "locationInModule": { "filename": "lib/log-group.ts", "line": 453 }, "name": "defaultValue", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "\"1\"", "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'.", "stability": "stable", "summary": "The value to emit for the metric." }, "immutable": true, "locationInModule": { "filename": "lib/log-group.ts", "line": 446 }, "name": "metricValue", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-logs.MetricFilterProps": { "assembly": "@aws-cdk/aws-logs", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for a MetricFilter." }, "fqn": "@aws-cdk/aws-logs.MetricFilterProps", "interfaces": [ "@aws-cdk/aws-logs.MetricFilterOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/metric-filter.ts", "line": 9 }, "name": "MetricFilterProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The log group to create the filter on." }, "immutable": true, "locationInModule": { "filename": "lib/metric-filter.ts", "line": 13 }, "name": "logGroup", "type": { "fqn": "@aws-cdk/aws-logs.ILogGroup" } } ] }, "@aws-cdk/aws-logs.RetentionDays": { "assembly": "@aws-cdk/aws-logs", "docs": { "stability": "stable", "summary": "How long, in days, the log contents will be retained." }, "fqn": "@aws-cdk/aws-logs.RetentionDays", "kind": "enum", "locationInModule": { "filename": "lib/log-group.ts", "line": 179 }, "members": [ { "docs": { "stability": "stable", "summary": "1 day." }, "name": "ONE_DAY" }, { "docs": { "stability": "stable", "summary": "3 days." }, "name": "THREE_DAYS" }, { "docs": { "stability": "stable", "summary": "5 days." }, "name": "FIVE_DAYS" }, { "docs": { "stability": "stable", "summary": "1 week." }, "name": "ONE_WEEK" }, { "docs": { "stability": "stable", "summary": "2 weeks." }, "name": "TWO_WEEKS" }, { "docs": { "stability": "stable", "summary": "1 month." }, "name": "ONE_MONTH" }, { "docs": { "stability": "stable", "summary": "2 months." }, "name": "TWO_MONTHS" }, { "docs": { "stability": "stable", "summary": "3 months." }, "name": "THREE_MONTHS" }, { "docs": { "stability": "stable", "summary": "4 months." }, "name": "FOUR_MONTHS" }, { "docs": { "stability": "stable", "summary": "5 months." }, "name": "FIVE_MONTHS" }, { "docs": { "stability": "stable", "summary": "6 months." }, "name": "SIX_MONTHS" }, { "docs": { "stability": "stable", "summary": "1 year." }, "name": "ONE_YEAR" }, { "docs": { "stability": "stable", "summary": "13 months." }, "name": "THIRTEEN_MONTHS" }, { "docs": { "stability": "stable", "summary": "18 months." }, "name": "EIGHTEEN_MONTHS" }, { "docs": { "stability": "stable", "summary": "2 years." }, "name": "TWO_YEARS" }, { "docs": { "stability": "stable", "summary": "5 years." }, "name": "FIVE_YEARS" }, { "docs": { "stability": "stable", "summary": "10 years." }, "name": "TEN_YEARS" }, { "docs": { "stability": "stable", "summary": "Retain logs forever." }, "name": "INFINITE" } ], "name": "RetentionDays" }, "@aws-cdk/aws-logs.SpaceDelimitedTextPattern": { "assembly": "@aws-cdk/aws-logs", "docs": { "stability": "stable", "summary": "Space delimited text pattern." }, "fqn": "@aws-cdk/aws-logs.SpaceDelimitedTextPattern", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/pattern.ts", "line": 299 }, "parameters": [ { "name": "columns", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "name": "restrictions", "type": { "collection": { "elementtype": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-logs.ColumnRestriction" }, "kind": "array" } }, "kind": "map" } } } ], "protected": true }, "interfaces": [ "@aws-cdk/aws-logs.IFilterPattern" ], "kind": "class", "locationInModule": { "filename": "lib/pattern.ts", "line": 271 }, "methods": [ { "docs": { "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.", "stability": "stable", "summary": "Construct a new instance of a space delimited text pattern." }, "locationInModule": { "filename": "lib/pattern.ts", "line": 281 }, "name": "construct", "parameters": [ { "name": "columns", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.SpaceDelimitedTextPattern" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Restrict where the pattern applies." }, "locationInModule": { "filename": "lib/pattern.ts", "line": 325 }, "name": "whereNumber", "parameters": [ { "name": "columnName", "type": { "primitive": "string" } }, { "name": "comparison", "type": { "primitive": "string" } }, { "name": "value", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.SpaceDelimitedTextPattern" } } }, { "docs": { "stability": "stable", "summary": "Restrict where the pattern applies." }, "locationInModule": { "filename": "lib/pattern.ts", "line": 306 }, "name": "whereString", "parameters": [ { "name": "columnName", "type": { "primitive": "string" } }, { "name": "comparison", "type": { "primitive": "string" } }, { "name": "value", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-logs.SpaceDelimitedTextPattern" } } } ], "name": "SpaceDelimitedTextPattern", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/pattern.ts", "line": 341 }, "name": "logPatternString", "overrides": "@aws-cdk/aws-logs.IFilterPattern", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-logs.StreamOptions": { "assembly": "@aws-cdk/aws-logs", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for a new LogStream created from a LogGroup." }, "fqn": "@aws-cdk/aws-logs.StreamOptions", "kind": "interface", "locationInModule": { "filename": "lib/log-group.ts", "line": 384 }, "name": "StreamOptions", "properties": [ { "abstract": true, "docs": { "default": "Automatically generated", "remarks": "The name must be unique within the log group.", "stability": "stable", "summary": "The name of the log stream to create." }, "immutable": true, "locationInModule": { "filename": "lib/log-group.ts", "line": 392 }, "name": "logStreamName", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-logs.SubscriptionFilter": { "assembly": "@aws-cdk/aws-logs", "base": "@aws-cdk/core.Resource", "docs": { "stability": "stable", "summary": "A new Subscription on a CloudWatch log group." }, "fqn": "@aws-cdk/aws-logs.SubscriptionFilter", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/subscription-filter.ts", "line": 54 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-logs.SubscriptionFilterProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/subscription-filter.ts", "line": 53 }, "name": "SubscriptionFilter" }, "@aws-cdk/aws-logs.SubscriptionFilterOptions": { "assembly": "@aws-cdk/aws-logs", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for a new SubscriptionFilter created from a LogGroup." }, "fqn": "@aws-cdk/aws-logs.SubscriptionFilterOptions", "kind": "interface", "locationInModule": { "filename": "lib/log-group.ts", "line": 398 }, "name": "SubscriptionFilterOptions", "properties": [ { "abstract": true, "docs": { "remarks": "For example, a Kinesis stream or a Lambda function.", "stability": "stable", "summary": "The destination to send the filtered events to." }, "immutable": true, "locationInModule": { "filename": "lib/log-group.ts", "line": 404 }, "name": "destination", "type": { "fqn": "@aws-cdk/aws-logs.ILogSubscriptionDestination" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Log events matching this pattern will be sent to the destination." }, "immutable": true, "locationInModule": { "filename": "lib/log-group.ts", "line": 409 }, "name": "filterPattern", "type": { "fqn": "@aws-cdk/aws-logs.IFilterPattern" } } ] }, "@aws-cdk/aws-logs.SubscriptionFilterProps": { "assembly": "@aws-cdk/aws-logs", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for a SubscriptionFilter." }, "fqn": "@aws-cdk/aws-logs.SubscriptionFilterProps", "interfaces": [ "@aws-cdk/aws-logs.SubscriptionFilterOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/subscription-filter.ts", "line": 43 }, "name": "SubscriptionFilterProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The log group to create the subscription on." }, "immutable": true, "locationInModule": { "filename": "lib/subscription-filter.ts", "line": 47 }, "name": "logGroup", "type": { "fqn": "@aws-cdk/aws-logs.ILogGroup" } } ] } }, "version": "1.64.0", "fingerprint": "4sRi+IvlptLG7A98+jboRhIpZPfy3ITJApUmrl3UXos=" }