{ "author": { "name": "Amazon Web Services", "organization": true, "roles": [ "author" ], "url": "https://aws.amazon.com" }, "dependencies": { "@aws-cdk/core": "1.204.0" }, "dependencyClosure": { "@aws-cdk/cloud-assembly-schema": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CloudAssembly.Schema", "packageId": "Amazon.CDK.CloudAssembly.Schema" }, "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": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.cloud-assembly-schema", "module": "aws_cdk.cloud_assembly_schema" } } }, "@aws-cdk/core": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK", "packageId": "Amazon.CDK" }, "java": { "maven": { "artifactId": "core", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.core" }, "js": { "npm": "@aws-cdk/core" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.core", "module": "aws_cdk.core" } } }, "@aws-cdk/cx-api": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CXAPI", "packageId": "Amazon.CDK.CXAPI" }, "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.cx-api", "module": "aws_cdk.cx_api" } } }, "@aws-cdk/region-info": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.RegionInfo", "packageId": "Amazon.CDK.RegionInfo" }, "java": { "maven": { "artifactId": "cdk-region-info", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.regioninfo" }, "js": { "npm": "@aws-cdk/region-info" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.region-info", "module": "aws_cdk.region_info" } } }, "constructs": { "targets": { "dotnet": { "namespace": "Constructs", "packageId": "Constructs" }, "go": { "moduleName": "github.com/aws/constructs-go" }, "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::LookoutMetrics", "docs": { "deprecated": "AWS CDK v1 has reached End-of-Support on 2023-06-01.\nThis package is no longer being updated, and users should migrate to AWS CDK v2.\n\nFor more information on how to migrate, see https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html", "stability": "experimental" }, "homepage": "https://github.com/aws/aws-cdk", "jsiiVersion": "1.84.0 (build 5404dcf)", "keywords": [ "aws", "cdk", "constructs", "AWS::LookoutMetrics", "aws-lookoutmetrics" ], "license": "Apache-2.0", "metadata": { "jsii": { "compiledWithDeprecationWarnings": true, "pacmak": { "hasDefaultInterfaces": true }, "rosetta": { "strict": true } } }, "name": "@aws-cdk/aws-lookoutmetrics", "readme": { "markdown": "# AWS::LookoutMetrics Construct Library\n\n\n---\n\n![End-of-Support](https://img.shields.io/badge/End--of--Support-critical.svg?style=for-the-badge)\n\n> AWS CDK v1 has reached End-of-Support on 2023-06-01.\n> This package is no longer being updated, and users should migrate to AWS CDK v2.\n>\n> For more information on how to migrate, see the [_Migrating to AWS CDK v2_ guide][doc].\n>\n> [doc]: https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html\n\n---\n\n\n\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n\n```ts nofixture\nimport * as lookoutmetrics from '@aws-cdk/aws-lookoutmetrics';\n```\n\n\n\nThere are no official hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet. Here are some suggestions on how to proceed:\n\n- Search [Construct Hub for LookoutMetrics construct libraries](https://constructs.dev/search?q=lookoutmetrics)\n- Use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, in the same way you would use [the CloudFormation AWS::LookoutMetrics resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_LookoutMetrics.html) directly.\n\n\n\n\nThere are no hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet.\nHowever, you can still use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, and use this service exactly as you would using CloudFormation directly.\n\nFor more information on the resources and properties available for this service, see the [CloudFormation documentation for AWS::LookoutMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_LookoutMetrics.html).\n\n(Read the [CDK Contributing Guide](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md) and submit an RFC if you are interested in contributing to this construct library.)\n\n\n" }, "repository": { "directory": "packages/@aws-cdk/aws-lookoutmetrics", "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.LookoutMetrics", "packageId": "Amazon.CDK.AWS.LookoutMetrics", "signAssembly": true }, "java": { "maven": { "artifactId": "lookoutmetrics", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.lookoutmetrics" }, "js": { "npm": "@aws-cdk/aws-lookoutmetrics" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-lookoutmetrics", "module": "aws_cdk.aws_lookoutmetrics" } }, "types": { "@aws-cdk/aws-lookoutmetrics.CfnAlert": { "assembly": "@aws-cdk/aws-lookoutmetrics", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::LookoutMetrics::Alert", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-alert.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::LookoutMetrics::Alert` type creates an alert for an anomaly detector.", "stability": "external", "summary": "A CloudFormation `AWS::LookoutMetrics::Alert`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lookoutmetrics from '@aws-cdk/aws-lookoutmetrics';\nconst cfnAlert = new lookoutmetrics.CfnAlert(this, 'MyCfnAlert', {\n action: {\n lambdaConfiguration: {\n lambdaArn: 'lambdaArn',\n roleArn: 'roleArn',\n },\n snsConfiguration: {\n roleArn: 'roleArn',\n snsTopicArn: 'snsTopicArn',\n },\n },\n alertSensitivityThreshold: 123,\n anomalyDetectorArn: 'anomalyDetectorArn',\n\n // the properties below are optional\n alertDescription: 'alertDescription',\n alertName: 'alertName',\n});" }, "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAlert", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::LookoutMetrics::Alert`." }, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 200 }, "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-lookoutmetrics.CfnAlertProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 127 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 220 }, "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/lookoutmetrics.generated.ts", "line": 235 }, "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": "CfnAlert", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 131 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "remarks": "For example, `arn:aws:lookoutmetrics:us-east-2:123456789012:Alert:my-alert`", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the alert." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 156 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 225 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-alert.html#cfn-lookoutmetrics-alert-action" }, "stability": "external", "summary": "Action that will be triggered when there is an alert." }, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 163 }, "name": "action", "type": { "union": { "types": [ { "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAlert.ActionProperty" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-alert.html#cfn-lookoutmetrics-alert-alertsensitivitythreshold" }, "stability": "external", "summary": "An integer from 0 to 100 specifying the alert sensitivity threshold." }, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 170 }, "name": "alertSensitivityThreshold", "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-alert.html#cfn-lookoutmetrics-alert-anomalydetectorarn" }, "stability": "external", "summary": "The ARN of the detector to which the alert is attached." }, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 177 }, "name": "anomalyDetectorArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-alert.html#cfn-lookoutmetrics-alert-alertdescription" }, "stability": "external", "summary": "A description of the alert." }, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 184 }, "name": "alertDescription", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-alert.html#cfn-lookoutmetrics-alert-alertname" }, "stability": "external", "summary": "The name of the alert." }, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 191 }, "name": "alertName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/lookoutmetrics.generated:CfnAlert" }, "@aws-cdk/aws-lookoutmetrics.CfnAlert.ActionProperty": { "assembly": "@aws-cdk/aws-lookoutmetrics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-alert-action.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "A configuration that specifies the action to perform when anomalies are detected.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lookoutmetrics from '@aws-cdk/aws-lookoutmetrics';\nconst actionProperty: lookoutmetrics.CfnAlert.ActionProperty = {\n lambdaConfiguration: {\n lambdaArn: 'lambdaArn',\n roleArn: 'roleArn',\n },\n snsConfiguration: {\n roleArn: 'roleArn',\n snsTopicArn: 'snsTopicArn',\n },\n};" }, "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAlert.ActionProperty", "kind": "interface", "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 249 }, "name": "ActionProperty", "namespace": "CfnAlert", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-alert-action.html#cfn-lookoutmetrics-alert-action-lambdaconfiguration" }, "stability": "external", "summary": "A configuration for an AWS Lambda channel." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 255 }, "name": "lambdaConfiguration", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAlert.LambdaConfigurationProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-alert-action.html#cfn-lookoutmetrics-alert-action-snsconfiguration" }, "stability": "external", "summary": "A configuration for an Amazon SNS channel." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 261 }, "name": "snsConfiguration", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAlert.SNSConfigurationProperty" } ] } } } ], "symbolId": "lib/lookoutmetrics.generated:CfnAlert.ActionProperty" }, "@aws-cdk/aws-lookoutmetrics.CfnAlert.LambdaConfigurationProperty": { "assembly": "@aws-cdk/aws-lookoutmetrics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-alert-lambdaconfiguration.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Contains information about a Lambda configuration.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lookoutmetrics from '@aws-cdk/aws-lookoutmetrics';\nconst lambdaConfigurationProperty: lookoutmetrics.CfnAlert.LambdaConfigurationProperty = {\n lambdaArn: 'lambdaArn',\n roleArn: 'roleArn',\n};" }, "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAlert.LambdaConfigurationProperty", "kind": "interface", "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 325 }, "name": "LambdaConfigurationProperty", "namespace": "CfnAlert", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-alert-lambdaconfiguration.html#cfn-lookoutmetrics-alert-lambdaconfiguration-lambdaarn" }, "stability": "external", "summary": "The ARN of the Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 331 }, "name": "lambdaArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-alert-lambdaconfiguration.html#cfn-lookoutmetrics-alert-lambdaconfiguration-rolearn" }, "stability": "external", "summary": "The ARN of an IAM role that has permission to invoke the Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 337 }, "name": "roleArn", "type": { "primitive": "string" } } ], "symbolId": "lib/lookoutmetrics.generated:CfnAlert.LambdaConfigurationProperty" }, "@aws-cdk/aws-lookoutmetrics.CfnAlert.SNSConfigurationProperty": { "assembly": "@aws-cdk/aws-lookoutmetrics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-alert-snsconfiguration.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Contains information about the SNS topic to which you want to send your alerts and the IAM role that has access to that topic.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lookoutmetrics from '@aws-cdk/aws-lookoutmetrics';\nconst sNSConfigurationProperty: lookoutmetrics.CfnAlert.SNSConfigurationProperty = {\n roleArn: 'roleArn',\n snsTopicArn: 'snsTopicArn',\n};" }, "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAlert.SNSConfigurationProperty", "kind": "interface", "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 403 }, "name": "SNSConfigurationProperty", "namespace": "CfnAlert", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-alert-snsconfiguration.html#cfn-lookoutmetrics-alert-snsconfiguration-rolearn" }, "stability": "external", "summary": "The ARN of the IAM role that has access to the target SNS topic." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 409 }, "name": "roleArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-alert-snsconfiguration.html#cfn-lookoutmetrics-alert-snsconfiguration-snstopicarn" }, "stability": "external", "summary": "The ARN of the target SNS topic." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 415 }, "name": "snsTopicArn", "type": { "primitive": "string" } } ], "symbolId": "lib/lookoutmetrics.generated:CfnAlert.SNSConfigurationProperty" }, "@aws-cdk/aws-lookoutmetrics.CfnAlertProps": { "assembly": "@aws-cdk/aws-lookoutmetrics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-alert.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnAlert`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lookoutmetrics from '@aws-cdk/aws-lookoutmetrics';\nconst cfnAlertProps: lookoutmetrics.CfnAlertProps = {\n action: {\n lambdaConfiguration: {\n lambdaArn: 'lambdaArn',\n roleArn: 'roleArn',\n },\n snsConfiguration: {\n roleArn: 'roleArn',\n snsTopicArn: 'snsTopicArn',\n },\n },\n alertSensitivityThreshold: 123,\n anomalyDetectorArn: 'anomalyDetectorArn',\n\n // the properties below are optional\n alertDescription: 'alertDescription',\n alertName: 'alertName',\n};" }, "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAlertProps", "kind": "interface", "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 19 }, "name": "CfnAlertProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-alert.html#cfn-lookoutmetrics-alert-action" }, "stability": "external", "summary": "Action that will be triggered when there is an alert." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 26 }, "name": "action", "type": { "union": { "types": [ { "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAlert.ActionProperty" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-alert.html#cfn-lookoutmetrics-alert-alertsensitivitythreshold" }, "stability": "external", "summary": "An integer from 0 to 100 specifying the alert sensitivity threshold." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 33 }, "name": "alertSensitivityThreshold", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-alert.html#cfn-lookoutmetrics-alert-anomalydetectorarn" }, "stability": "external", "summary": "The ARN of the detector to which the alert is attached." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 40 }, "name": "anomalyDetectorArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-alert.html#cfn-lookoutmetrics-alert-alertdescription" }, "stability": "external", "summary": "A description of the alert." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 47 }, "name": "alertDescription", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-alert.html#cfn-lookoutmetrics-alert-alertname" }, "stability": "external", "summary": "The name of the alert." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 54 }, "name": "alertName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/lookoutmetrics.generated:CfnAlertProps" }, "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector": { "assembly": "@aws-cdk/aws-lookoutmetrics", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::LookoutMetrics::AnomalyDetector", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-anomalydetector.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::LookoutMetrics::AnomalyDetector` type creates an anomaly detector.", "stability": "external", "summary": "A CloudFormation `AWS::LookoutMetrics::AnomalyDetector`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lookoutmetrics from '@aws-cdk/aws-lookoutmetrics';\nconst cfnAnomalyDetector = new lookoutmetrics.CfnAnomalyDetector(this, 'MyCfnAnomalyDetector', {\n anomalyDetectorConfig: {\n anomalyDetectorFrequency: 'anomalyDetectorFrequency',\n },\n metricSetList: [{\n metricList: [{\n aggregationFunction: 'aggregationFunction',\n metricName: 'metricName',\n\n // the properties below are optional\n namespace: 'namespace',\n }],\n metricSetName: 'metricSetName',\n metricSource: {\n appFlowConfig: {\n flowName: 'flowName',\n roleArn: 'roleArn',\n },\n cloudwatchConfig: {\n roleArn: 'roleArn',\n },\n rdsSourceConfig: {\n databaseHost: 'databaseHost',\n databaseName: 'databaseName',\n databasePort: 123,\n dbInstanceIdentifier: 'dbInstanceIdentifier',\n roleArn: 'roleArn',\n secretManagerArn: 'secretManagerArn',\n tableName: 'tableName',\n vpcConfiguration: {\n securityGroupIdList: ['securityGroupIdList'],\n subnetIdList: ['subnetIdList'],\n },\n },\n redshiftSourceConfig: {\n clusterIdentifier: 'clusterIdentifier',\n databaseHost: 'databaseHost',\n databaseName: 'databaseName',\n databasePort: 123,\n roleArn: 'roleArn',\n secretManagerArn: 'secretManagerArn',\n tableName: 'tableName',\n vpcConfiguration: {\n securityGroupIdList: ['securityGroupIdList'],\n subnetIdList: ['subnetIdList'],\n },\n },\n s3SourceConfig: {\n fileFormatDescriptor: {\n csvFormatDescriptor: {\n charset: 'charset',\n containsHeader: false,\n delimiter: 'delimiter',\n fileCompression: 'fileCompression',\n headerList: ['headerList'],\n quoteSymbol: 'quoteSymbol',\n },\n jsonFormatDescriptor: {\n charset: 'charset',\n fileCompression: 'fileCompression',\n },\n },\n roleArn: 'roleArn',\n\n // the properties below are optional\n historicalDataPathList: ['historicalDataPathList'],\n templatedPathList: ['templatedPathList'],\n },\n },\n\n // the properties below are optional\n dimensionList: ['dimensionList'],\n metricSetDescription: 'metricSetDescription',\n metricSetFrequency: 'metricSetFrequency',\n offset: 123,\n timestampColumn: {\n columnFormat: 'columnFormat',\n columnName: 'columnName',\n },\n timezone: 'timezone',\n }],\n\n // the properties below are optional\n anomalyDetectorDescription: 'anomalyDetectorDescription',\n anomalyDetectorName: 'anomalyDetectorName',\n kmsKeyArn: 'kmsKeyArn',\n});" }, "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::LookoutMetrics::AnomalyDetector`." }, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 660 }, "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-lookoutmetrics.CfnAnomalyDetectorProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 587 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 679 }, "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/lookoutmetrics.generated.ts", "line": 694 }, "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": "CfnAnomalyDetector", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 591 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "remarks": "For example, `arn:aws:lookoutmetrics:us-east-2:123456789012:AnomalyDetector:my-detector`", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the detector." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 616 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 684 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-anomalydetector.html#cfn-lookoutmetrics-anomalydetector-anomalydetectorconfig" }, "stability": "external", "summary": "Contains information about the configuration of the anomaly detector." }, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 623 }, "name": "anomalyDetectorConfig", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.AnomalyDetectorConfigProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-anomalydetector.html#cfn-lookoutmetrics-anomalydetector-metricsetlist" }, "stability": "external", "summary": "The detector's dataset." }, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 630 }, "name": "metricSetList", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.MetricSetProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-anomalydetector.html#cfn-lookoutmetrics-anomalydetector-anomalydetectordescription" }, "stability": "external", "summary": "A description of the detector." }, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 637 }, "name": "anomalyDetectorDescription", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-anomalydetector.html#cfn-lookoutmetrics-anomalydetector-anomalydetectorname" }, "stability": "external", "summary": "The name of the detector." }, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 644 }, "name": "anomalyDetectorName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-anomalydetector.html#cfn-lookoutmetrics-anomalydetector-kmskeyarn" }, "stability": "external", "summary": "The ARN of the KMS key to use to encrypt your data." }, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 651 }, "name": "kmsKeyArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/lookoutmetrics.generated:CfnAnomalyDetector" }, "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.AnomalyDetectorConfigProperty": { "assembly": "@aws-cdk/aws-lookoutmetrics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-anomalydetectorconfig.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Contains information about a detector's configuration.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lookoutmetrics from '@aws-cdk/aws-lookoutmetrics';\nconst anomalyDetectorConfigProperty: lookoutmetrics.CfnAnomalyDetector.AnomalyDetectorConfigProperty = {\n anomalyDetectorFrequency: 'anomalyDetectorFrequency',\n};" }, "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.AnomalyDetectorConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 708 }, "name": "AnomalyDetectorConfigProperty", "namespace": "CfnAnomalyDetector", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-anomalydetectorconfig.html#cfn-lookoutmetrics-anomalydetector-anomalydetectorconfig-anomalydetectorfrequency" }, "stability": "external", "summary": "The frequency at which the detector analyzes its source data." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 714 }, "name": "anomalyDetectorFrequency", "type": { "primitive": "string" } } ], "symbolId": "lib/lookoutmetrics.generated:CfnAnomalyDetector.AnomalyDetectorConfigProperty" }, "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.AppFlowConfigProperty": { "assembly": "@aws-cdk/aws-lookoutmetrics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-appflowconfig.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Details about an Amazon AppFlow flow datasource.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lookoutmetrics from '@aws-cdk/aws-lookoutmetrics';\nconst appFlowConfigProperty: lookoutmetrics.CfnAnomalyDetector.AppFlowConfigProperty = {\n flowName: 'flowName',\n roleArn: 'roleArn',\n};" }, "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.AppFlowConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 776 }, "name": "AppFlowConfigProperty", "namespace": "CfnAnomalyDetector", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-appflowconfig.html#cfn-lookoutmetrics-anomalydetector-appflowconfig-flowname" }, "stability": "external", "summary": "name of the flow." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 782 }, "name": "flowName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-appflowconfig.html#cfn-lookoutmetrics-anomalydetector-appflowconfig-rolearn" }, "stability": "external", "summary": "An IAM role that gives Amazon Lookout for Metrics permission to access the flow." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 788 }, "name": "roleArn", "type": { "primitive": "string" } } ], "symbolId": "lib/lookoutmetrics.generated:CfnAnomalyDetector.AppFlowConfigProperty" }, "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.CloudwatchConfigProperty": { "assembly": "@aws-cdk/aws-lookoutmetrics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-cloudwatchconfig.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Details about an Amazon CloudWatch datasource.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lookoutmetrics from '@aws-cdk/aws-lookoutmetrics';\nconst cloudwatchConfigProperty: lookoutmetrics.CfnAnomalyDetector.CloudwatchConfigProperty = {\n roleArn: 'roleArn',\n};" }, "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.CloudwatchConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 854 }, "name": "CloudwatchConfigProperty", "namespace": "CfnAnomalyDetector", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-cloudwatchconfig.html#cfn-lookoutmetrics-anomalydetector-cloudwatchconfig-rolearn" }, "stability": "external", "summary": "An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 860 }, "name": "roleArn", "type": { "primitive": "string" } } ], "symbolId": "lib/lookoutmetrics.generated:CfnAnomalyDetector.CloudwatchConfigProperty" }, "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.CsvFormatDescriptorProperty": { "assembly": "@aws-cdk/aws-lookoutmetrics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-csvformatdescriptor.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Contains information about how a source CSV data file should be analyzed.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lookoutmetrics from '@aws-cdk/aws-lookoutmetrics';\nconst csvFormatDescriptorProperty: lookoutmetrics.CfnAnomalyDetector.CsvFormatDescriptorProperty = {\n charset: 'charset',\n containsHeader: false,\n delimiter: 'delimiter',\n fileCompression: 'fileCompression',\n headerList: ['headerList'],\n quoteSymbol: 'quoteSymbol',\n};" }, "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.CsvFormatDescriptorProperty", "kind": "interface", "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 922 }, "name": "CsvFormatDescriptorProperty", "namespace": "CfnAnomalyDetector", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-csvformatdescriptor.html#cfn-lookoutmetrics-anomalydetector-csvformatdescriptor-charset" }, "stability": "external", "summary": "The character set in which the source CSV file is written." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 928 }, "name": "charset", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-csvformatdescriptor.html#cfn-lookoutmetrics-anomalydetector-csvformatdescriptor-containsheader" }, "stability": "external", "summary": "Whether or not the source CSV file contains a header." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 934 }, "name": "containsHeader", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-csvformatdescriptor.html#cfn-lookoutmetrics-anomalydetector-csvformatdescriptor-delimiter" }, "stability": "external", "summary": "The character used to delimit the source CSV file." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 940 }, "name": "delimiter", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-csvformatdescriptor.html#cfn-lookoutmetrics-anomalydetector-csvformatdescriptor-filecompression" }, "stability": "external", "summary": "The level of compression of the source CSV file." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 946 }, "name": "fileCompression", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-csvformatdescriptor.html#cfn-lookoutmetrics-anomalydetector-csvformatdescriptor-headerlist" }, "stability": "external", "summary": "A list of the source CSV file's headers, if any." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 952 }, "name": "headerList", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-csvformatdescriptor.html#cfn-lookoutmetrics-anomalydetector-csvformatdescriptor-quotesymbol" }, "stability": "external", "summary": "The character used as a quote character." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 958 }, "name": "quoteSymbol", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/lookoutmetrics.generated:CfnAnomalyDetector.CsvFormatDescriptorProperty" }, "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.FileFormatDescriptorProperty": { "assembly": "@aws-cdk/aws-lookoutmetrics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-fileformatdescriptor.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Contains information about a source file's formatting.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lookoutmetrics from '@aws-cdk/aws-lookoutmetrics';\nconst fileFormatDescriptorProperty: lookoutmetrics.CfnAnomalyDetector.FileFormatDescriptorProperty = {\n csvFormatDescriptor: {\n charset: 'charset',\n containsHeader: false,\n delimiter: 'delimiter',\n fileCompression: 'fileCompression',\n headerList: ['headerList'],\n quoteSymbol: 'quoteSymbol',\n },\n jsonFormatDescriptor: {\n charset: 'charset',\n fileCompression: 'fileCompression',\n },\n};" }, "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.FileFormatDescriptorProperty", "kind": "interface", "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1034 }, "name": "FileFormatDescriptorProperty", "namespace": "CfnAnomalyDetector", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-fileformatdescriptor.html#cfn-lookoutmetrics-anomalydetector-fileformatdescriptor-csvformatdescriptor" }, "stability": "external", "summary": "Contains information about how a source CSV data file should be analyzed." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1040 }, "name": "csvFormatDescriptor", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.CsvFormatDescriptorProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-fileformatdescriptor.html#cfn-lookoutmetrics-anomalydetector-fileformatdescriptor-jsonformatdescriptor" }, "stability": "external", "summary": "Contains information about how a source JSON data file should be analyzed." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1046 }, "name": "jsonFormatDescriptor", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.JsonFormatDescriptorProperty" } ] } } } ], "symbolId": "lib/lookoutmetrics.generated:CfnAnomalyDetector.FileFormatDescriptorProperty" }, "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.JsonFormatDescriptorProperty": { "assembly": "@aws-cdk/aws-lookoutmetrics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-jsonformatdescriptor.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Contains information about how a source JSON data file should be analyzed.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lookoutmetrics from '@aws-cdk/aws-lookoutmetrics';\nconst jsonFormatDescriptorProperty: lookoutmetrics.CfnAnomalyDetector.JsonFormatDescriptorProperty = {\n charset: 'charset',\n fileCompression: 'fileCompression',\n};" }, "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.JsonFormatDescriptorProperty", "kind": "interface", "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1110 }, "name": "JsonFormatDescriptorProperty", "namespace": "CfnAnomalyDetector", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-jsonformatdescriptor.html#cfn-lookoutmetrics-anomalydetector-jsonformatdescriptor-charset" }, "stability": "external", "summary": "The character set in which the source JSON file is written." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1116 }, "name": "charset", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-jsonformatdescriptor.html#cfn-lookoutmetrics-anomalydetector-jsonformatdescriptor-filecompression" }, "stability": "external", "summary": "The level of compression of the source CSV file." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1122 }, "name": "fileCompression", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/lookoutmetrics.generated:CfnAnomalyDetector.JsonFormatDescriptorProperty" }, "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.MetricProperty": { "assembly": "@aws-cdk/aws-lookoutmetrics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metric.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "A calculation made by contrasting a measure and a dimension from your source data.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lookoutmetrics from '@aws-cdk/aws-lookoutmetrics';\nconst metricProperty: lookoutmetrics.CfnAnomalyDetector.MetricProperty = {\n aggregationFunction: 'aggregationFunction',\n metricName: 'metricName',\n\n // the properties below are optional\n namespace: 'namespace',\n};" }, "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.MetricProperty", "kind": "interface", "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1186 }, "name": "MetricProperty", "namespace": "CfnAnomalyDetector", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metric.html#cfn-lookoutmetrics-anomalydetector-metric-aggregationfunction" }, "stability": "external", "summary": "The function with which the metric is calculated." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1192 }, "name": "aggregationFunction", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metric.html#cfn-lookoutmetrics-anomalydetector-metric-metricname" }, "stability": "external", "summary": "The name of the metric." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1198 }, "name": "metricName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metric.html#cfn-lookoutmetrics-anomalydetector-metric-namespace" }, "stability": "external", "summary": "The namespace for the metric." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1204 }, "name": "namespace", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/lookoutmetrics.generated:CfnAnomalyDetector.MetricProperty" }, "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.MetricSetProperty": { "assembly": "@aws-cdk/aws-lookoutmetrics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricset.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Contains information about a dataset.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lookoutmetrics from '@aws-cdk/aws-lookoutmetrics';\nconst metricSetProperty: lookoutmetrics.CfnAnomalyDetector.MetricSetProperty = {\n metricList: [{\n aggregationFunction: 'aggregationFunction',\n metricName: 'metricName',\n\n // the properties below are optional\n namespace: 'namespace',\n }],\n metricSetName: 'metricSetName',\n metricSource: {\n appFlowConfig: {\n flowName: 'flowName',\n roleArn: 'roleArn',\n },\n cloudwatchConfig: {\n roleArn: 'roleArn',\n },\n rdsSourceConfig: {\n databaseHost: 'databaseHost',\n databaseName: 'databaseName',\n databasePort: 123,\n dbInstanceIdentifier: 'dbInstanceIdentifier',\n roleArn: 'roleArn',\n secretManagerArn: 'secretManagerArn',\n tableName: 'tableName',\n vpcConfiguration: {\n securityGroupIdList: ['securityGroupIdList'],\n subnetIdList: ['subnetIdList'],\n },\n },\n redshiftSourceConfig: {\n clusterIdentifier: 'clusterIdentifier',\n databaseHost: 'databaseHost',\n databaseName: 'databaseName',\n databasePort: 123,\n roleArn: 'roleArn',\n secretManagerArn: 'secretManagerArn',\n tableName: 'tableName',\n vpcConfiguration: {\n securityGroupIdList: ['securityGroupIdList'],\n subnetIdList: ['subnetIdList'],\n },\n },\n s3SourceConfig: {\n fileFormatDescriptor: {\n csvFormatDescriptor: {\n charset: 'charset',\n containsHeader: false,\n delimiter: 'delimiter',\n fileCompression: 'fileCompression',\n headerList: ['headerList'],\n quoteSymbol: 'quoteSymbol',\n },\n jsonFormatDescriptor: {\n charset: 'charset',\n fileCompression: 'fileCompression',\n },\n },\n roleArn: 'roleArn',\n\n // the properties below are optional\n historicalDataPathList: ['historicalDataPathList'],\n templatedPathList: ['templatedPathList'],\n },\n },\n\n // the properties below are optional\n dimensionList: ['dimensionList'],\n metricSetDescription: 'metricSetDescription',\n metricSetFrequency: 'metricSetFrequency',\n offset: 123,\n timestampColumn: {\n columnFormat: 'columnFormat',\n columnName: 'columnName',\n },\n timezone: 'timezone',\n};" }, "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.MetricSetProperty", "kind": "interface", "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1273 }, "name": "MetricSetProperty", "namespace": "CfnAnomalyDetector", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricset.html#cfn-lookoutmetrics-anomalydetector-metricset-metriclist" }, "stability": "external", "summary": "A list of metrics that the dataset will contain." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1285 }, "name": "metricList", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.MetricProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricset.html#cfn-lookoutmetrics-anomalydetector-metricset-metricsetname" }, "stability": "external", "summary": "The name of the dataset." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1303 }, "name": "metricSetName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricset.html#cfn-lookoutmetrics-anomalydetector-metricset-metricsource" }, "stability": "external", "summary": "Contains information about how the source data should be interpreted." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1309 }, "name": "metricSource", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.MetricSourceProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricset.html#cfn-lookoutmetrics-anomalydetector-metricset-dimensionlist" }, "stability": "external", "summary": "A list of the fields you want to treat as dimensions." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1279 }, "name": "dimensionList", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricset.html#cfn-lookoutmetrics-anomalydetector-metricset-metricsetdescription" }, "stability": "external", "summary": "A description of the dataset you are creating." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1291 }, "name": "metricSetDescription", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricset.html#cfn-lookoutmetrics-anomalydetector-metricset-metricsetfrequency" }, "stability": "external", "summary": "The frequency with which the source data will be analyzed for anomalies." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1297 }, "name": "metricSetFrequency", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricset.html#cfn-lookoutmetrics-anomalydetector-metricset-offset" }, "remarks": "Offset is only supported for S3, Redshift, Athena and datasources.", "stability": "external", "summary": "After an interval ends, the amount of seconds that the detector waits before importing data." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1315 }, "name": "offset", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricset.html#cfn-lookoutmetrics-anomalydetector-metricset-timestampcolumn" }, "stability": "external", "summary": "Contains information about the column used for tracking time in your source data." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1321 }, "name": "timestampColumn", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.TimestampColumnProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricset.html#cfn-lookoutmetrics-anomalydetector-metricset-timezone" }, "stability": "external", "summary": "The time zone in which your source data was recorded." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1327 }, "name": "timezone", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/lookoutmetrics.generated:CfnAnomalyDetector.MetricSetProperty" }, "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.MetricSourceProperty": { "assembly": "@aws-cdk/aws-lookoutmetrics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricsource.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Contains information about how the source data should be interpreted.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lookoutmetrics from '@aws-cdk/aws-lookoutmetrics';\nconst metricSourceProperty: lookoutmetrics.CfnAnomalyDetector.MetricSourceProperty = {\n appFlowConfig: {\n flowName: 'flowName',\n roleArn: 'roleArn',\n },\n cloudwatchConfig: {\n roleArn: 'roleArn',\n },\n rdsSourceConfig: {\n databaseHost: 'databaseHost',\n databaseName: 'databaseName',\n databasePort: 123,\n dbInstanceIdentifier: 'dbInstanceIdentifier',\n roleArn: 'roleArn',\n secretManagerArn: 'secretManagerArn',\n tableName: 'tableName',\n vpcConfiguration: {\n securityGroupIdList: ['securityGroupIdList'],\n subnetIdList: ['subnetIdList'],\n },\n },\n redshiftSourceConfig: {\n clusterIdentifier: 'clusterIdentifier',\n databaseHost: 'databaseHost',\n databaseName: 'databaseName',\n databasePort: 123,\n roleArn: 'roleArn',\n secretManagerArn: 'secretManagerArn',\n tableName: 'tableName',\n vpcConfiguration: {\n securityGroupIdList: ['securityGroupIdList'],\n subnetIdList: ['subnetIdList'],\n },\n },\n s3SourceConfig: {\n fileFormatDescriptor: {\n csvFormatDescriptor: {\n charset: 'charset',\n containsHeader: false,\n delimiter: 'delimiter',\n fileCompression: 'fileCompression',\n headerList: ['headerList'],\n quoteSymbol: 'quoteSymbol',\n },\n jsonFormatDescriptor: {\n charset: 'charset',\n fileCompression: 'fileCompression',\n },\n },\n roleArn: 'roleArn',\n\n // the properties below are optional\n historicalDataPathList: ['historicalDataPathList'],\n templatedPathList: ['templatedPathList'],\n },\n};" }, "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.MetricSourceProperty", "kind": "interface", "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1415 }, "name": "MetricSourceProperty", "namespace": "CfnAnomalyDetector", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricsource.html#cfn-lookoutmetrics-anomalydetector-metricsource-appflowconfig" }, "stability": "external", "summary": "Details about an AppFlow datasource." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1421 }, "name": "appFlowConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.AppFlowConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricsource.html#cfn-lookoutmetrics-anomalydetector-metricsource-cloudwatchconfig" }, "stability": "external", "summary": "Details about an Amazon CloudWatch monitoring datasource." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1427 }, "name": "cloudwatchConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.CloudwatchConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricsource.html#cfn-lookoutmetrics-anomalydetector-metricsource-rdssourceconfig" }, "stability": "external", "summary": "Details about an Amazon Relational Database Service (RDS) datasource." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1433 }, "name": "rdsSourceConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.RDSSourceConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricsource.html#cfn-lookoutmetrics-anomalydetector-metricsource-redshiftsourceconfig" }, "stability": "external", "summary": "Details about an Amazon Redshift database datasource." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1439 }, "name": "redshiftSourceConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.RedshiftSourceConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricsource.html#cfn-lookoutmetrics-anomalydetector-metricsource-s3sourceconfig" }, "stability": "external", "summary": "Contains information about the configuration of the S3 bucket that contains source files." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1445 }, "name": "s3SourceConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.S3SourceConfigProperty" } ] } } } ], "symbolId": "lib/lookoutmetrics.generated:CfnAnomalyDetector.MetricSourceProperty" }, "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.RDSSourceConfigProperty": { "assembly": "@aws-cdk/aws-lookoutmetrics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Contains information about the Amazon Relational Database Service (RDS) configuration.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lookoutmetrics from '@aws-cdk/aws-lookoutmetrics';\nconst rDSSourceConfigProperty: lookoutmetrics.CfnAnomalyDetector.RDSSourceConfigProperty = {\n databaseHost: 'databaseHost',\n databaseName: 'databaseName',\n databasePort: 123,\n dbInstanceIdentifier: 'dbInstanceIdentifier',\n roleArn: 'roleArn',\n secretManagerArn: 'secretManagerArn',\n tableName: 'tableName',\n vpcConfiguration: {\n securityGroupIdList: ['securityGroupIdList'],\n subnetIdList: ['subnetIdList'],\n },\n};" }, "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.RDSSourceConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1518 }, "name": "RDSSourceConfigProperty", "namespace": "CfnAnomalyDetector", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.html#cfn-lookoutmetrics-anomalydetector-rdssourceconfig-databasehost" }, "stability": "external", "summary": "The host name of the database." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1530 }, "name": "databaseHost", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.html#cfn-lookoutmetrics-anomalydetector-rdssourceconfig-databasename" }, "stability": "external", "summary": "The name of the RDS database." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1536 }, "name": "databaseName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.html#cfn-lookoutmetrics-anomalydetector-rdssourceconfig-databaseport" }, "stability": "external", "summary": "The port number where the database can be accessed." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1542 }, "name": "databasePort", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.html#cfn-lookoutmetrics-anomalydetector-rdssourceconfig-dbinstanceidentifier" }, "stability": "external", "summary": "A string identifying the database instance." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1524 }, "name": "dbInstanceIdentifier", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.html#cfn-lookoutmetrics-anomalydetector-rdssourceconfig-rolearn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the role." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1548 }, "name": "roleArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.html#cfn-lookoutmetrics-anomalydetector-rdssourceconfig-secretmanagerarn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the AWS Secrets Manager role." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1554 }, "name": "secretManagerArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.html#cfn-lookoutmetrics-anomalydetector-rdssourceconfig-tablename" }, "stability": "external", "summary": "The name of the table in the database." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1560 }, "name": "tableName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.html#cfn-lookoutmetrics-anomalydetector-rdssourceconfig-vpcconfiguration" }, "stability": "external", "summary": "An object containing information about the Amazon Virtual Private Cloud (VPC) configuration." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1566 }, "name": "vpcConfiguration", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.VpcConfigurationProperty" } ] } } } ], "symbolId": "lib/lookoutmetrics.generated:CfnAnomalyDetector.RDSSourceConfigProperty" }, "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.RedshiftSourceConfigProperty": { "assembly": "@aws-cdk/aws-lookoutmetrics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Provides information about the Amazon Redshift database configuration.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lookoutmetrics from '@aws-cdk/aws-lookoutmetrics';\nconst redshiftSourceConfigProperty: lookoutmetrics.CfnAnomalyDetector.RedshiftSourceConfigProperty = {\n clusterIdentifier: 'clusterIdentifier',\n databaseHost: 'databaseHost',\n databaseName: 'databaseName',\n databasePort: 123,\n roleArn: 'roleArn',\n secretManagerArn: 'secretManagerArn',\n tableName: 'tableName',\n vpcConfiguration: {\n securityGroupIdList: ['securityGroupIdList'],\n subnetIdList: ['subnetIdList'],\n },\n};" }, "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.RedshiftSourceConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1656 }, "name": "RedshiftSourceConfigProperty", "namespace": "CfnAnomalyDetector", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.html#cfn-lookoutmetrics-anomalydetector-redshiftsourceconfig-clusteridentifier" }, "stability": "external", "summary": "A string identifying the Redshift cluster." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1662 }, "name": "clusterIdentifier", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.html#cfn-lookoutmetrics-anomalydetector-redshiftsourceconfig-databasehost" }, "stability": "external", "summary": "The name of the database host." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1668 }, "name": "databaseHost", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.html#cfn-lookoutmetrics-anomalydetector-redshiftsourceconfig-databasename" }, "stability": "external", "summary": "The Redshift database name." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1674 }, "name": "databaseName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.html#cfn-lookoutmetrics-anomalydetector-redshiftsourceconfig-databaseport" }, "stability": "external", "summary": "The port number where the database can be accessed." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1680 }, "name": "databasePort", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.html#cfn-lookoutmetrics-anomalydetector-redshiftsourceconfig-rolearn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the role providing access to the database." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1686 }, "name": "roleArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.html#cfn-lookoutmetrics-anomalydetector-redshiftsourceconfig-secretmanagerarn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the AWS Secrets Manager role." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1692 }, "name": "secretManagerArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.html#cfn-lookoutmetrics-anomalydetector-redshiftsourceconfig-tablename" }, "stability": "external", "summary": "The table name of the Redshift database." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1698 }, "name": "tableName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.html#cfn-lookoutmetrics-anomalydetector-redshiftsourceconfig-vpcconfiguration" }, "stability": "external", "summary": "Contains information about the Amazon Virtual Private Cloud (VPC) configuration." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1704 }, "name": "vpcConfiguration", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.VpcConfigurationProperty" } ] } } } ], "symbolId": "lib/lookoutmetrics.generated:CfnAnomalyDetector.RedshiftSourceConfigProperty" }, "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.S3SourceConfigProperty": { "assembly": "@aws-cdk/aws-lookoutmetrics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-s3sourceconfig.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Contains information about the configuration of the S3 bucket that contains source files.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lookoutmetrics from '@aws-cdk/aws-lookoutmetrics';\nconst s3SourceConfigProperty: lookoutmetrics.CfnAnomalyDetector.S3SourceConfigProperty = {\n fileFormatDescriptor: {\n csvFormatDescriptor: {\n charset: 'charset',\n containsHeader: false,\n delimiter: 'delimiter',\n fileCompression: 'fileCompression',\n headerList: ['headerList'],\n quoteSymbol: 'quoteSymbol',\n },\n jsonFormatDescriptor: {\n charset: 'charset',\n fileCompression: 'fileCompression',\n },\n },\n roleArn: 'roleArn',\n\n // the properties below are optional\n historicalDataPathList: ['historicalDataPathList'],\n templatedPathList: ['templatedPathList'],\n};" }, "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.S3SourceConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1794 }, "name": "S3SourceConfigProperty", "namespace": "CfnAnomalyDetector", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-s3sourceconfig.html#cfn-lookoutmetrics-anomalydetector-s3sourceconfig-fileformatdescriptor" }, "stability": "external", "summary": "Contains information about a source file's formatting." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1800 }, "name": "fileFormatDescriptor", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.FileFormatDescriptorProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-s3sourceconfig.html#cfn-lookoutmetrics-anomalydetector-s3sourceconfig-rolearn" }, "stability": "external", "summary": "The ARN of an IAM role that has read and write access permissions to the source S3 bucket." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1812 }, "name": "roleArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-s3sourceconfig.html#cfn-lookoutmetrics-anomalydetector-s3sourceconfig-historicaldatapathlist" }, "stability": "external", "summary": "A list of paths to the historical data files." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1806 }, "name": "historicalDataPathList", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-s3sourceconfig.html#cfn-lookoutmetrics-anomalydetector-s3sourceconfig-templatedpathlist" }, "stability": "external", "summary": "A list of templated paths to the source files." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1818 }, "name": "templatedPathList", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/lookoutmetrics.generated:CfnAnomalyDetector.S3SourceConfigProperty" }, "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.TimestampColumnProperty": { "assembly": "@aws-cdk/aws-lookoutmetrics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-timestampcolumn.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Contains information about the column used to track time in a source data file.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lookoutmetrics from '@aws-cdk/aws-lookoutmetrics';\nconst timestampColumnProperty: lookoutmetrics.CfnAnomalyDetector.TimestampColumnProperty = {\n columnFormat: 'columnFormat',\n columnName: 'columnName',\n};" }, "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.TimestampColumnProperty", "kind": "interface", "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1890 }, "name": "TimestampColumnProperty", "namespace": "CfnAnomalyDetector", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-timestampcolumn.html#cfn-lookoutmetrics-anomalydetector-timestampcolumn-columnformat" }, "stability": "external", "summary": "The format of the timestamp column." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1896 }, "name": "columnFormat", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-timestampcolumn.html#cfn-lookoutmetrics-anomalydetector-timestampcolumn-columnname" }, "stability": "external", "summary": "The name of the timestamp column." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1902 }, "name": "columnName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/lookoutmetrics.generated:CfnAnomalyDetector.TimestampColumnProperty" }, "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.VpcConfigurationProperty": { "assembly": "@aws-cdk/aws-lookoutmetrics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-vpcconfiguration.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Contains configuration information about the Amazon Virtual Private Cloud (VPC).", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lookoutmetrics from '@aws-cdk/aws-lookoutmetrics';\nconst vpcConfigurationProperty: lookoutmetrics.CfnAnomalyDetector.VpcConfigurationProperty = {\n securityGroupIdList: ['securityGroupIdList'],\n subnetIdList: ['subnetIdList'],\n};" }, "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.VpcConfigurationProperty", "kind": "interface", "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1966 }, "name": "VpcConfigurationProperty", "namespace": "CfnAnomalyDetector", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-vpcconfiguration.html#cfn-lookoutmetrics-anomalydetector-vpcconfiguration-securitygroupidlist" }, "stability": "external", "summary": "An array of strings containing the list of security groups." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1972 }, "name": "securityGroupIdList", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-vpcconfiguration.html#cfn-lookoutmetrics-anomalydetector-vpcconfiguration-subnetidlist" }, "stability": "external", "summary": "An array of strings containing the Amazon VPC subnet IDs (e.g., `subnet-0bb1c79de3EXAMPLE` ." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 1978 }, "name": "subnetIdList", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/lookoutmetrics.generated:CfnAnomalyDetector.VpcConfigurationProperty" }, "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetectorProps": { "assembly": "@aws-cdk/aws-lookoutmetrics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-anomalydetector.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnAnomalyDetector`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lookoutmetrics from '@aws-cdk/aws-lookoutmetrics';\nconst cfnAnomalyDetectorProps: lookoutmetrics.CfnAnomalyDetectorProps = {\n anomalyDetectorConfig: {\n anomalyDetectorFrequency: 'anomalyDetectorFrequency',\n },\n metricSetList: [{\n metricList: [{\n aggregationFunction: 'aggregationFunction',\n metricName: 'metricName',\n\n // the properties below are optional\n namespace: 'namespace',\n }],\n metricSetName: 'metricSetName',\n metricSource: {\n appFlowConfig: {\n flowName: 'flowName',\n roleArn: 'roleArn',\n },\n cloudwatchConfig: {\n roleArn: 'roleArn',\n },\n rdsSourceConfig: {\n databaseHost: 'databaseHost',\n databaseName: 'databaseName',\n databasePort: 123,\n dbInstanceIdentifier: 'dbInstanceIdentifier',\n roleArn: 'roleArn',\n secretManagerArn: 'secretManagerArn',\n tableName: 'tableName',\n vpcConfiguration: {\n securityGroupIdList: ['securityGroupIdList'],\n subnetIdList: ['subnetIdList'],\n },\n },\n redshiftSourceConfig: {\n clusterIdentifier: 'clusterIdentifier',\n databaseHost: 'databaseHost',\n databaseName: 'databaseName',\n databasePort: 123,\n roleArn: 'roleArn',\n secretManagerArn: 'secretManagerArn',\n tableName: 'tableName',\n vpcConfiguration: {\n securityGroupIdList: ['securityGroupIdList'],\n subnetIdList: ['subnetIdList'],\n },\n },\n s3SourceConfig: {\n fileFormatDescriptor: {\n csvFormatDescriptor: {\n charset: 'charset',\n containsHeader: false,\n delimiter: 'delimiter',\n fileCompression: 'fileCompression',\n headerList: ['headerList'],\n quoteSymbol: 'quoteSymbol',\n },\n jsonFormatDescriptor: {\n charset: 'charset',\n fileCompression: 'fileCompression',\n },\n },\n roleArn: 'roleArn',\n\n // the properties below are optional\n historicalDataPathList: ['historicalDataPathList'],\n templatedPathList: ['templatedPathList'],\n },\n },\n\n // the properties below are optional\n dimensionList: ['dimensionList'],\n metricSetDescription: 'metricSetDescription',\n metricSetFrequency: 'metricSetFrequency',\n offset: 123,\n timestampColumn: {\n columnFormat: 'columnFormat',\n columnName: 'columnName',\n },\n timezone: 'timezone',\n }],\n\n // the properties below are optional\n anomalyDetectorDescription: 'anomalyDetectorDescription',\n anomalyDetectorName: 'anomalyDetectorName',\n kmsKeyArn: 'kmsKeyArn',\n};" }, "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetectorProps", "kind": "interface", "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 480 }, "name": "CfnAnomalyDetectorProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-anomalydetector.html#cfn-lookoutmetrics-anomalydetector-anomalydetectorconfig" }, "stability": "external", "summary": "Contains information about the configuration of the anomaly detector." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 487 }, "name": "anomalyDetectorConfig", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.AnomalyDetectorConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-anomalydetector.html#cfn-lookoutmetrics-anomalydetector-metricsetlist" }, "stability": "external", "summary": "The detector's dataset." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 494 }, "name": "metricSetList", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lookoutmetrics.CfnAnomalyDetector.MetricSetProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-anomalydetector.html#cfn-lookoutmetrics-anomalydetector-anomalydetectordescription" }, "stability": "external", "summary": "A description of the detector." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 501 }, "name": "anomalyDetectorDescription", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-anomalydetector.html#cfn-lookoutmetrics-anomalydetector-anomalydetectorname" }, "stability": "external", "summary": "The name of the detector." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 508 }, "name": "anomalyDetectorName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-anomalydetector.html#cfn-lookoutmetrics-anomalydetector-kmskeyarn" }, "stability": "external", "summary": "The ARN of the KMS key to use to encrypt your data." }, "immutable": true, "locationInModule": { "filename": "lib/lookoutmetrics.generated.ts", "line": 515 }, "name": "kmsKeyArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/lookoutmetrics.generated:CfnAnomalyDetectorProps" } }, "version": "1.204.0", "fingerprint": "**********" }