{ "author": { "email": "aws-cdk-dev@amazon.com", "name": "Amazon Web Services", "organization": true, "roles": [ "author" ] }, "dependencies": { "aws-cdk-lib": "^2.160.0", "constructs": "^10.0.5" }, "dependencyClosure": { "@aws-cdk/asset-awscli-v1": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Asset.AwsCliV1", "packageId": "Amazon.CDK.Asset.AwsCliV1" }, "go": { "moduleName": "github.com/cdklabs/awscdk-asset-awscli-go", "packageName": "awscliv1" }, "java": { "maven": { "artifactId": "cdk-asset-awscli-v1", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cdk.asset.awscli.v1" }, "js": { "npm": "@aws-cdk/asset-awscli-v1" }, "python": { "distName": "aws-cdk.asset-awscli-v1", "module": "aws_cdk.asset_awscli_v1" } } }, "@aws-cdk/asset-kubectl-v20": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Asset.KubectlV20", "packageId": "Amazon.CDK.Asset.KubectlV20" }, "go": { "moduleName": "github.com/cdklabs/awscdk-asset-kubectl-go", "packageName": "kubectlv20" }, "java": { "maven": { "artifactId": "cdk-asset-kubectl-v20", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cdk.asset.kubectl.v20" }, "js": { "npm": "@aws-cdk/asset-kubectl-v20" }, "python": { "distName": "aws-cdk.asset-kubectl-v20", "module": "aws_cdk.asset_kubectl_v20" } } }, "@aws-cdk/asset-node-proxy-agent-v6": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Asset.NodeProxyAgentV6", "packageId": "Amazon.CDK.Asset.NodeProxyAgentV6" }, "go": { "moduleName": "github.com/cdklabs/awscdk-asset-node-proxy-agent-go", "packageName": "nodeproxyagentv6" }, "java": { "maven": { "artifactId": "cdk-asset-node-proxy-agent-v6", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cdk.asset.node.proxy.agent.v6" }, "js": { "npm": "@aws-cdk/asset-node-proxy-agent-v6" }, "python": { "distName": "aws-cdk.asset-node-proxy-agent-v6", "module": "aws_cdk.asset_node_proxy_agent_v6" } } }, "@aws-cdk/cloud-assembly-schema": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/main/logo/default-256-dark.png", "namespace": "Amazon.CDK.CloudAssembly.Schema", "packageId": "Amazon.CDK.CloudAssembly.Schema" }, "go": { "moduleName": "github.com/cdklabs/cloud-assembly-schema-go" }, "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 :: 2" ], "distName": "aws-cdk.cloud-assembly-schema", "module": "aws_cdk.cloud_assembly_schema" } } }, "aws-cdk-lib": { "submodules": { "aws-cdk-lib.alexa_ask": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Alexa.Ask" }, "java": { "package": "software.amazon.awscdk.alexa.ask" }, "python": { "module": "aws_cdk.alexa_ask" } } }, "aws-cdk-lib.assertions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Assertions" }, "java": { "package": "software.amazon.awscdk.assertions" }, "python": { "module": "aws_cdk.assertions" } } }, "aws-cdk-lib.assets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Assets" }, "java": { "package": "software.amazon.awscdk.assets" }, "python": { "module": "aws_cdk.assets" } } }, "aws-cdk-lib.aws_accessanalyzer": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AccessAnalyzer" }, "java": { "package": "software.amazon.awscdk.services.accessanalyzer" }, "python": { "module": "aws_cdk.aws_accessanalyzer" } } }, "aws-cdk-lib.aws_acmpca": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ACMPCA" }, "java": { "package": "software.amazon.awscdk.services.acmpca" }, "python": { "module": "aws_cdk.aws_acmpca" } } }, "aws-cdk-lib.aws_amazonmq": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AmazonMQ" }, "java": { "package": "software.amazon.awscdk.services.amazonmq" }, "python": { "module": "aws_cdk.aws_amazonmq" } } }, "aws-cdk-lib.aws_amplify": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Amplify" }, "java": { "package": "software.amazon.awscdk.services.amplify" }, "python": { "module": "aws_cdk.aws_amplify" } } }, "aws-cdk-lib.aws_amplifyuibuilder": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AmplifyUIBuilder" }, "java": { "package": "software.amazon.awscdk.services.amplifyuibuilder" }, "python": { "module": "aws_cdk.aws_amplifyuibuilder" } } }, "aws-cdk-lib.aws_apigateway": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.APIGateway" }, "java": { "package": "software.amazon.awscdk.services.apigateway" }, "python": { "module": "aws_cdk.aws_apigateway" } } }, "aws-cdk-lib.aws_apigatewayv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Apigatewayv2" }, "java": { "package": "software.amazon.awscdk.services.apigatewayv2" }, "python": { "module": "aws_cdk.aws_apigatewayv2" } } }, "aws-cdk-lib.aws_apigatewayv2_authorizers": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AwsApigatewayv2Authorizers" }, "java": { "package": "software.amazon.awscdk.aws_apigatewayv2_authorizers" }, "python": { "module": "aws_cdk.aws_apigatewayv2_authorizers" } } }, "aws-cdk-lib.aws_apigatewayv2_integrations": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AwsApigatewayv2Integrations" }, "java": { "package": "software.amazon.awscdk.aws_apigatewayv2_integrations" }, "python": { "module": "aws_cdk.aws_apigatewayv2_integrations" } } }, "aws-cdk-lib.aws_appconfig": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppConfig" }, "java": { "package": "software.amazon.awscdk.services.appconfig" }, "python": { "module": "aws_cdk.aws_appconfig" } } }, "aws-cdk-lib.aws_appflow": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppFlow" }, "java": { "package": "software.amazon.awscdk.services.appflow" }, "python": { "module": "aws_cdk.aws_appflow" } } }, "aws-cdk-lib.aws_appintegrations": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppIntegrations" }, "java": { "package": "software.amazon.awscdk.services.appintegrations" }, "python": { "module": "aws_cdk.aws_appintegrations" } } }, "aws-cdk-lib.aws_applicationautoscaling": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ApplicationAutoScaling" }, "java": { "package": "software.amazon.awscdk.services.applicationautoscaling" }, "python": { "module": "aws_cdk.aws_applicationautoscaling" } } }, "aws-cdk-lib.aws_applicationinsights": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ApplicationInsights" }, "java": { "package": "software.amazon.awscdk.services.applicationinsights" }, "python": { "module": "aws_cdk.aws_applicationinsights" } } }, "aws-cdk-lib.aws_applicationsignals": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.ApplicationSignals" }, "java": { "package": "software.amazon.awscdk.services.applicationsignals" }, "python": { "module": "aws_cdk.aws_applicationsignals" } } }, "aws-cdk-lib.aws_appmesh": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppMesh" }, "java": { "package": "software.amazon.awscdk.services.appmesh" }, "python": { "module": "aws_cdk.aws_appmesh" } } }, "aws-cdk-lib.aws_apprunner": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppRunner" }, "java": { "package": "software.amazon.awscdk.services.apprunner" }, "python": { "module": "aws_cdk.aws_apprunner" } } }, "aws-cdk-lib.aws_appstream": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppStream" }, "java": { "package": "software.amazon.awscdk.services.appstream" }, "python": { "module": "aws_cdk.aws_appstream" } } }, "aws-cdk-lib.aws_appsync": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppSync" }, "java": { "package": "software.amazon.awscdk.services.appsync" }, "python": { "module": "aws_cdk.aws_appsync" } } }, "aws-cdk-lib.aws_apptest": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.AppTest" }, "java": { "package": "software.amazon.awscdk.services.apptest" }, "python": { "module": "aws_cdk.aws_apptest" } } }, "aws-cdk-lib.aws_aps": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.APS" }, "java": { "package": "software.amazon.awscdk.services.aps" }, "python": { "module": "aws_cdk.aws_aps" } } }, "aws-cdk-lib.aws_arczonalshift": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.ARCZonalShift" }, "java": { "package": "software.amazon.awscdk.services.arczonalshift" }, "python": { "module": "aws_cdk.aws_arczonalshift" } } }, "aws-cdk-lib.aws_athena": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Athena" }, "java": { "package": "software.amazon.awscdk.services.athena" }, "python": { "module": "aws_cdk.aws_athena" } } }, "aws-cdk-lib.aws_auditmanager": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AuditManager" }, "java": { "package": "software.amazon.awscdk.services.auditmanager" }, "python": { "module": "aws_cdk.aws_auditmanager" } } }, "aws-cdk-lib.aws_autoscaling": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AutoScaling" }, "java": { "package": "software.amazon.awscdk.services.autoscaling" }, "python": { "module": "aws_cdk.aws_autoscaling" } } }, "aws-cdk-lib.aws_autoscaling_common": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AutoScaling.Common" }, "java": { "package": "software.amazon.awscdk.services.autoscaling.common" }, "python": { "module": "aws_cdk.aws_autoscaling_common" } } }, "aws-cdk-lib.aws_autoscaling_hooktargets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AutoScaling.HookTargets" }, "java": { "package": "software.amazon.awscdk.services.autoscaling.hooktargets" }, "python": { "module": "aws_cdk.aws_autoscaling_hooktargets" } } }, "aws-cdk-lib.aws_autoscalingplans": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AutoScalingPlans" }, "java": { "package": "software.amazon.awscdk.services.autoscalingplans" }, "python": { "module": "aws_cdk.aws_autoscalingplans" } } }, "aws-cdk-lib.aws_b2bi": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.B2BI" }, "java": { "package": "software.amazon.awscdk.services.b2bi" }, "python": { "module": "aws_cdk.aws_b2bi" } } }, "aws-cdk-lib.aws_backup": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Backup" }, "java": { "package": "software.amazon.awscdk.services.backup" }, "python": { "module": "aws_cdk.aws_backup" } } }, "aws-cdk-lib.aws_backupgateway": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.BackupGateway" }, "java": { "package": "software.amazon.awscdk.services.backupgateway" }, "python": { "module": "aws_cdk.aws_backupgateway" } } }, "aws-cdk-lib.aws_batch": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Batch" }, "java": { "package": "software.amazon.awscdk.services.batch" }, "python": { "module": "aws_cdk.aws_batch" } } }, "aws-cdk-lib.aws_bcmdataexports": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.BCMDataExports" }, "java": { "package": "software.amazon.awscdk.services.bcmdataexports" }, "python": { "module": "aws_cdk.aws_bcmdataexports" } } }, "aws-cdk-lib.aws_bedrock": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.Bedrock" }, "java": { "package": "software.amazon.awscdk.services.bedrock" }, "python": { "module": "aws_cdk.aws_bedrock" } } }, "aws-cdk-lib.aws_billingconductor": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.BillingConductor" }, "java": { "package": "software.amazon.awscdk.services.billingconductor" }, "python": { "module": "aws_cdk.aws_billingconductor" } } }, "aws-cdk-lib.aws_budgets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Budgets" }, "java": { "package": "software.amazon.awscdk.services.budgets" }, "python": { "module": "aws_cdk.aws_budgets" } } }, "aws-cdk-lib.aws_cassandra": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Cassandra" }, "java": { "package": "software.amazon.awscdk.services.cassandra" }, "python": { "module": "aws_cdk.aws_cassandra" } } }, "aws-cdk-lib.aws_ce": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CE" }, "java": { "package": "software.amazon.awscdk.services.ce" }, "python": { "module": "aws_cdk.aws_ce" } } }, "aws-cdk-lib.aws_certificatemanager": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CertificateManager" }, "java": { "package": "software.amazon.awscdk.services.certificatemanager" }, "python": { "module": "aws_cdk.aws_certificatemanager" } } }, "aws-cdk-lib.aws_chatbot": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Chatbot" }, "java": { "package": "software.amazon.awscdk.services.chatbot" }, "python": { "module": "aws_cdk.aws_chatbot" } } }, "aws-cdk-lib.aws_cleanrooms": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.CleanRooms" }, "java": { "package": "software.amazon.awscdk.services.cleanrooms" }, "python": { "module": "aws_cdk.aws_cleanrooms" } } }, "aws-cdk-lib.aws_cleanroomsml": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.CleanRoomsML" }, "java": { "package": "software.amazon.awscdk.services.cleanroomsml" }, "python": { "module": "aws_cdk.aws_cleanroomsml" } } }, "aws-cdk-lib.aws_cloud9": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Cloud9" }, "java": { "package": "software.amazon.awscdk.services.cloud9" }, "python": { "module": "aws_cdk.aws_cloud9" } } }, "aws-cdk-lib.aws_cloudformation": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudFormation" }, "java": { "package": "software.amazon.awscdk.services.cloudformation" }, "python": { "module": "aws_cdk.aws_cloudformation" } } }, "aws-cdk-lib.aws_cloudfront": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudFront" }, "java": { "package": "software.amazon.awscdk.services.cloudfront" }, "python": { "module": "aws_cdk.aws_cloudfront" } } }, "aws-cdk-lib.aws_cloudfront.experimental": {}, "aws-cdk-lib.aws_cloudfront_origins": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudFront.Origins" }, "java": { "package": "software.amazon.awscdk.services.cloudfront.origins" }, "python": { "module": "aws_cdk.aws_cloudfront_origins" } } }, "aws-cdk-lib.aws_cloudtrail": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudTrail" }, "java": { "package": "software.amazon.awscdk.services.cloudtrail" }, "python": { "module": "aws_cdk.aws_cloudtrail" } } }, "aws-cdk-lib.aws_cloudwatch": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudWatch" }, "java": { "package": "software.amazon.awscdk.services.cloudwatch" }, "python": { "module": "aws_cdk.aws_cloudwatch" } } }, "aws-cdk-lib.aws_cloudwatch_actions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudWatch.Actions" }, "java": { "package": "software.amazon.awscdk.services.cloudwatch.actions" }, "python": { "module": "aws_cdk.aws_cloudwatch_actions" } } }, "aws-cdk-lib.aws_codeartifact": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeArtifact" }, "java": { "package": "software.amazon.awscdk.services.codeartifact" }, "python": { "module": "aws_cdk.aws_codeartifact" } } }, "aws-cdk-lib.aws_codebuild": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeBuild" }, "java": { "package": "software.amazon.awscdk.services.codebuild" }, "python": { "module": "aws_cdk.aws_codebuild" } } }, "aws-cdk-lib.aws_codecommit": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeCommit" }, "java": { "package": "software.amazon.awscdk.services.codecommit" }, "python": { "module": "aws_cdk.aws_codecommit" } } }, "aws-cdk-lib.aws_codeconnections": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.CodeConnections" }, "java": { "package": "software.amazon.awscdk.services.codeconnections" }, "python": { "module": "aws_cdk.aws_codeconnections" } } }, "aws-cdk-lib.aws_codedeploy": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeDeploy" }, "java": { "package": "software.amazon.awscdk.services.codedeploy" }, "python": { "module": "aws_cdk.aws_codedeploy" } } }, "aws-cdk-lib.aws_codeguruprofiler": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeGuruProfiler" }, "java": { "package": "software.amazon.awscdk.services.codeguruprofiler" }, "python": { "module": "aws_cdk.aws_codeguruprofiler" } } }, "aws-cdk-lib.aws_codegurureviewer": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeGuruReviewer" }, "java": { "package": "software.amazon.awscdk.services.codegurureviewer" }, "python": { "module": "aws_cdk.aws_codegurureviewer" } } }, "aws-cdk-lib.aws_codepipeline": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodePipeline" }, "java": { "package": "software.amazon.awscdk.services.codepipeline" }, "python": { "module": "aws_cdk.aws_codepipeline" } } }, "aws-cdk-lib.aws_codepipeline_actions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodePipeline.Actions" }, "java": { "package": "software.amazon.awscdk.services.codepipeline.actions" }, "python": { "module": "aws_cdk.aws_codepipeline_actions" } } }, "aws-cdk-lib.aws_codestar": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Codestar" }, "java": { "package": "software.amazon.awscdk.services.codestar" }, "python": { "module": "aws_cdk.aws_codestar" } } }, "aws-cdk-lib.aws_codestarconnections": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeStarConnections" }, "java": { "package": "software.amazon.awscdk.services.codestarconnections" }, "python": { "module": "aws_cdk.aws_codestarconnections" } } }, "aws-cdk-lib.aws_codestarnotifications": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeStarNotifications" }, "java": { "package": "software.amazon.awscdk.services.codestarnotifications" }, "python": { "module": "aws_cdk.aws_codestarnotifications" } } }, "aws-cdk-lib.aws_cognito": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Cognito" }, "java": { "package": "software.amazon.awscdk.services.cognito" }, "python": { "module": "aws_cdk.aws_cognito" } } }, "aws-cdk-lib.aws_comprehend": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Comprehend" }, "java": { "package": "software.amazon.awscdk.services.comprehend" }, "python": { "module": "aws_cdk.aws_comprehend" } } }, "aws-cdk-lib.aws_config": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Config" }, "java": { "package": "software.amazon.awscdk.services.config" }, "python": { "module": "aws_cdk.aws_config" } } }, "aws-cdk-lib.aws_connect": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Connect" }, "java": { "package": "software.amazon.awscdk.services.connect" }, "python": { "module": "aws_cdk.aws_connect" } } }, "aws-cdk-lib.aws_connectcampaigns": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ConnectCampaigns" }, "java": { "package": "software.amazon.awscdk.services.connectcampaigns" }, "python": { "module": "aws_cdk.aws_connectcampaigns" } } }, "aws-cdk-lib.aws_controltower": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ControlTower" }, "java": { "package": "software.amazon.awscdk.services.controltower" }, "python": { "module": "aws_cdk.aws_controltower" } } }, "aws-cdk-lib.aws_cur": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CUR" }, "java": { "package": "software.amazon.awscdk.services.cur" }, "python": { "module": "aws_cdk.aws_cur" } } }, "aws-cdk-lib.aws_customerprofiles": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CustomerProfiles" }, "java": { "package": "software.amazon.awscdk.services.customerprofiles" }, "python": { "module": "aws_cdk.aws_customerprofiles" } } }, "aws-cdk-lib.aws_databrew": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DataBrew" }, "java": { "package": "software.amazon.awscdk.services.databrew" }, "python": { "module": "aws_cdk.aws_databrew" } } }, "aws-cdk-lib.aws_datapipeline": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DataPipeline" }, "java": { "package": "software.amazon.awscdk.services.datapipeline" }, "python": { "module": "aws_cdk.aws_datapipeline" } } }, "aws-cdk-lib.aws_datasync": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DataSync" }, "java": { "package": "software.amazon.awscdk.services.datasync" }, "python": { "module": "aws_cdk.aws_datasync" } } }, "aws-cdk-lib.aws_datazone": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.DataZone" }, "java": { "package": "software.amazon.awscdk.services.datazone" }, "python": { "module": "aws_cdk.aws_datazone" } } }, "aws-cdk-lib.aws_dax": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DAX" }, "java": { "package": "software.amazon.awscdk.services.dax" }, "python": { "module": "aws_cdk.aws_dax" } } }, "aws-cdk-lib.aws_deadline": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.Deadline" }, "java": { "package": "software.amazon.awscdk.services.deadline" }, "python": { "module": "aws_cdk.aws_deadline" } } }, "aws-cdk-lib.aws_detective": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Detective" }, "java": { "package": "software.amazon.awscdk.services.detective" }, "python": { "module": "aws_cdk.aws_detective" } } }, "aws-cdk-lib.aws_devicefarm": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DeviceFarm" }, "java": { "package": "software.amazon.awscdk.services.devicefarm" }, "python": { "module": "aws_cdk.aws_devicefarm" } } }, "aws-cdk-lib.aws_devopsguru": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DevOpsGuru" }, "java": { "package": "software.amazon.awscdk.services.devopsguru" }, "python": { "module": "aws_cdk.aws_devopsguru" } } }, "aws-cdk-lib.aws_directoryservice": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DirectoryService" }, "java": { "package": "software.amazon.awscdk.services.directoryservice" }, "python": { "module": "aws_cdk.aws_directoryservice" } } }, "aws-cdk-lib.aws_dlm": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DLM" }, "java": { "package": "software.amazon.awscdk.services.dlm" }, "python": { "module": "aws_cdk.aws_dlm" } } }, "aws-cdk-lib.aws_dms": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DMS" }, "java": { "package": "software.amazon.awscdk.services.dms" }, "python": { "module": "aws_cdk.aws_dms" } } }, "aws-cdk-lib.aws_docdb": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DocDB" }, "java": { "package": "software.amazon.awscdk.services.docdb" }, "python": { "module": "aws_cdk.aws_docdb" } } }, "aws-cdk-lib.aws_docdbelastic": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DocDBElastic" }, "java": { "package": "software.amazon.awscdk.services.docdbelastic" }, "python": { "module": "aws_cdk.aws_docdbelastic" } } }, "aws-cdk-lib.aws_dynamodb": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DynamoDB" }, "java": { "package": "software.amazon.awscdk.services.dynamodb" }, "python": { "module": "aws_cdk.aws_dynamodb" } } }, "aws-cdk-lib.aws_ec2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EC2" }, "java": { "package": "software.amazon.awscdk.services.ec2" }, "python": { "module": "aws_cdk.aws_ec2" } } }, "aws-cdk-lib.aws_ecr": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ECR" }, "java": { "package": "software.amazon.awscdk.services.ecr" }, "python": { "module": "aws_cdk.aws_ecr" } } }, "aws-cdk-lib.aws_ecr_assets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Ecr.Assets" }, "java": { "package": "software.amazon.awscdk.services.ecr.assets" }, "python": { "module": "aws_cdk.aws_ecr_assets" } } }, "aws-cdk-lib.aws_ecs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ECS" }, "java": { "package": "software.amazon.awscdk.services.ecs" }, "python": { "module": "aws_cdk.aws_ecs" } } }, "aws-cdk-lib.aws_ecs_patterns": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ECS.Patterns" }, "java": { "package": "software.amazon.awscdk.services.ecs.patterns" }, "python": { "module": "aws_cdk.aws_ecs_patterns" } } }, "aws-cdk-lib.aws_efs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EFS" }, "java": { "package": "software.amazon.awscdk.services.efs" }, "python": { "module": "aws_cdk.aws_efs" } } }, "aws-cdk-lib.aws_eks": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EKS" }, "java": { "package": "software.amazon.awscdk.services.eks" }, "python": { "module": "aws_cdk.aws_eks" } } }, "aws-cdk-lib.aws_elasticache": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElastiCache" }, "java": { "package": "software.amazon.awscdk.services.elasticache" }, "python": { "module": "aws_cdk.aws_elasticache" } } }, "aws-cdk-lib.aws_elasticbeanstalk": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElasticBeanstalk" }, "java": { "package": "software.amazon.awscdk.services.elasticbeanstalk" }, "python": { "module": "aws_cdk.aws_elasticbeanstalk" } } }, "aws-cdk-lib.aws_elasticloadbalancing": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElasticLoadBalancing" }, "java": { "package": "software.amazon.awscdk.services.elasticloadbalancing" }, "python": { "module": "aws_cdk.aws_elasticloadbalancing" } } }, "aws-cdk-lib.aws_elasticloadbalancingv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElasticLoadBalancingV2" }, "java": { "package": "software.amazon.awscdk.services.elasticloadbalancingv2" }, "python": { "module": "aws_cdk.aws_elasticloadbalancingv2" } } }, "aws-cdk-lib.aws_elasticloadbalancingv2_actions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElasticLoadBalancingV2.Actions" }, "java": { "package": "software.amazon.awscdk.services.elasticloadbalancingv2.actions" }, "python": { "module": "aws_cdk.aws_elasticloadbalancingv2_actions" } } }, "aws-cdk-lib.aws_elasticloadbalancingv2_targets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElasticLoadBalancingV2.Targets" }, "java": { "package": "software.amazon.awscdk.services.elasticloadbalancingv2.targets" }, "python": { "module": "aws_cdk.aws_elasticloadbalancingv2_targets" } } }, "aws-cdk-lib.aws_elasticsearch": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Elasticsearch" }, "java": { "package": "software.amazon.awscdk.services.elasticsearch" }, "python": { "module": "aws_cdk.aws_elasticsearch" } } }, "aws-cdk-lib.aws_emr": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EMR" }, "java": { "package": "software.amazon.awscdk.services.emr" }, "python": { "module": "aws_cdk.aws_emr" } } }, "aws-cdk-lib.aws_emrcontainers": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EMRContainers" }, "java": { "package": "software.amazon.awscdk.services.emrcontainers" }, "python": { "module": "aws_cdk.aws_emrcontainers" } } }, "aws-cdk-lib.aws_emrserverless": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EMRServerless" }, "java": { "package": "software.amazon.awscdk.services.emrserverless" }, "python": { "module": "aws_cdk.aws_emrserverless" } } }, "aws-cdk-lib.aws_entityresolution": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.EntityResolution" }, "java": { "package": "software.amazon.awscdk.services.entityresolution" }, "python": { "module": "aws_cdk.aws_entityresolution" } } }, "aws-cdk-lib.aws_events": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Events" }, "java": { "package": "software.amazon.awscdk.services.events" }, "python": { "module": "aws_cdk.aws_events" } } }, "aws-cdk-lib.aws_events_targets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Events.Targets" }, "java": { "package": "software.amazon.awscdk.services.events.targets" }, "python": { "module": "aws_cdk.aws_events_targets" } } }, "aws-cdk-lib.aws_eventschemas": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EventSchemas" }, "java": { "package": "software.amazon.awscdk.services.eventschemas" }, "python": { "module": "aws_cdk.aws_eventschemas" } } }, "aws-cdk-lib.aws_evidently": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Evidently" }, "java": { "package": "software.amazon.awscdk.services.evidently" }, "python": { "module": "aws_cdk.aws_evidently" } } }, "aws-cdk-lib.aws_finspace": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.FinSpace" }, "java": { "package": "software.amazon.awscdk.services.finspace" }, "python": { "module": "aws_cdk.aws_finspace" } } }, "aws-cdk-lib.aws_fis": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.FIS" }, "java": { "package": "software.amazon.awscdk.services.fis" }, "python": { "module": "aws_cdk.aws_fis" } } }, "aws-cdk-lib.aws_fms": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.FMS" }, "java": { "package": "software.amazon.awscdk.services.fms" }, "python": { "module": "aws_cdk.aws_fms" } } }, "aws-cdk-lib.aws_forecast": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Forecast" }, "java": { "package": "software.amazon.awscdk.services.forecast" }, "python": { "module": "aws_cdk.aws_forecast" } } }, "aws-cdk-lib.aws_frauddetector": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.FraudDetector" }, "java": { "package": "software.amazon.awscdk.services.frauddetector" }, "python": { "module": "aws_cdk.aws_frauddetector" } } }, "aws-cdk-lib.aws_fsx": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.FSx" }, "java": { "package": "software.amazon.awscdk.services.fsx" }, "python": { "module": "aws_cdk.aws_fsx" } } }, "aws-cdk-lib.aws_gamelift": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GameLift" }, "java": { "package": "software.amazon.awscdk.services.gamelift" }, "python": { "module": "aws_cdk.aws_gamelift" } } }, "aws-cdk-lib.aws_globalaccelerator": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GlobalAccelerator" }, "java": { "package": "software.amazon.awscdk.services.globalaccelerator" }, "python": { "module": "aws_cdk.aws_globalaccelerator" } } }, "aws-cdk-lib.aws_globalaccelerator_endpoints": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GlobalAccelerator.Endpoints" }, "java": { "package": "software.amazon.awscdk.services.globalaccelerator.endpoints" }, "python": { "module": "aws_cdk.aws_globalaccelerator_endpoints" } } }, "aws-cdk-lib.aws_glue": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Glue" }, "java": { "package": "software.amazon.awscdk.services.glue" }, "python": { "module": "aws_cdk.aws_glue" } } }, "aws-cdk-lib.aws_grafana": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Grafana" }, "java": { "package": "software.amazon.awscdk.services.grafana" }, "python": { "module": "aws_cdk.aws_grafana" } } }, "aws-cdk-lib.aws_greengrass": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Greengrass" }, "java": { "package": "software.amazon.awscdk.services.greengrass" }, "python": { "module": "aws_cdk.aws_greengrass" } } }, "aws-cdk-lib.aws_greengrassv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GreengrassV2" }, "java": { "package": "software.amazon.awscdk.services.greengrassv2" }, "python": { "module": "aws_cdk.aws_greengrassv2" } } }, "aws-cdk-lib.aws_groundstation": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GroundStation" }, "java": { "package": "software.amazon.awscdk.services.groundstation" }, "python": { "module": "aws_cdk.aws_groundstation" } } }, "aws-cdk-lib.aws_guardduty": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GuardDuty" }, "java": { "package": "software.amazon.awscdk.services.guardduty" }, "python": { "module": "aws_cdk.aws_guardduty" } } }, "aws-cdk-lib.aws_healthimaging": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.HealthImaging" }, "java": { "package": "software.amazon.awscdk.services.healthimaging" }, "python": { "module": "aws_cdk.aws_healthimaging" } } }, "aws-cdk-lib.aws_healthlake": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.HealthLake" }, "java": { "package": "software.amazon.awscdk.services.healthlake" }, "python": { "module": "aws_cdk.aws_healthlake" } } }, "aws-cdk-lib.aws_iam": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IAM" }, "java": { "package": "software.amazon.awscdk.services.iam" }, "python": { "module": "aws_cdk.aws_iam" } } }, "aws-cdk-lib.aws_identitystore": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IdentityStore" }, "java": { "package": "software.amazon.awscdk.services.identitystore" }, "python": { "module": "aws_cdk.aws_identitystore" } } }, "aws-cdk-lib.aws_imagebuilder": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ImageBuilder" }, "java": { "package": "software.amazon.awscdk.services.imagebuilder" }, "python": { "module": "aws_cdk.aws_imagebuilder" } } }, "aws-cdk-lib.aws_inspector": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Inspector" }, "java": { "package": "software.amazon.awscdk.services.inspector" }, "python": { "module": "aws_cdk.aws_inspector" } } }, "aws-cdk-lib.aws_inspectorv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.InspectorV2" }, "java": { "package": "software.amazon.awscdk.services.inspectorv2" }, "python": { "module": "aws_cdk.aws_inspectorv2" } } }, "aws-cdk-lib.aws_internetmonitor": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.InternetMonitor" }, "java": { "package": "software.amazon.awscdk.services.internetmonitor" }, "python": { "module": "aws_cdk.aws_internetmonitor" } } }, "aws-cdk-lib.aws_iot": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoT" }, "java": { "package": "software.amazon.awscdk.services.iot" }, "python": { "module": "aws_cdk.aws_iot" } } }, "aws-cdk-lib.aws_iot1click": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoT1Click" }, "java": { "package": "software.amazon.awscdk.services.iot1click" }, "python": { "module": "aws_cdk.aws_iot1click" } } }, "aws-cdk-lib.aws_iotanalytics": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTAnalytics" }, "java": { "package": "software.amazon.awscdk.services.iotanalytics" }, "python": { "module": "aws_cdk.aws_iotanalytics" } } }, "aws-cdk-lib.aws_iotcoredeviceadvisor": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTCoreDeviceAdvisor" }, "java": { "package": "software.amazon.awscdk.services.iotcoredeviceadvisor" }, "python": { "module": "aws_cdk.aws_iotcoredeviceadvisor" } } }, "aws-cdk-lib.aws_iotevents": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTEvents" }, "java": { "package": "software.amazon.awscdk.services.iotevents" }, "python": { "module": "aws_cdk.aws_iotevents" } } }, "aws-cdk-lib.aws_iotfleethub": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTFleetHub" }, "java": { "package": "software.amazon.awscdk.services.iotfleethub" }, "python": { "module": "aws_cdk.aws_iotfleethub" } } }, "aws-cdk-lib.aws_iotfleetwise": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTFleetWise" }, "java": { "package": "software.amazon.awscdk.services.iotfleetwise" }, "python": { "module": "aws_cdk.aws_iotfleetwise" } } }, "aws-cdk-lib.aws_iotsitewise": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTSiteWise" }, "java": { "package": "software.amazon.awscdk.services.iotsitewise" }, "python": { "module": "aws_cdk.aws_iotsitewise" } } }, "aws-cdk-lib.aws_iotthingsgraph": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTThingsGraph" }, "java": { "package": "software.amazon.awscdk.services.iotthingsgraph" }, "python": { "module": "aws_cdk.aws_iotthingsgraph" } } }, "aws-cdk-lib.aws_iottwinmaker": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTTwinMaker" }, "java": { "package": "software.amazon.awscdk.services.iottwinmaker" }, "python": { "module": "aws_cdk.aws_iottwinmaker" } } }, "aws-cdk-lib.aws_iotwireless": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTWireless" }, "java": { "package": "software.amazon.awscdk.services.iotwireless" }, "python": { "module": "aws_cdk.aws_iotwireless" } } }, "aws-cdk-lib.aws_ivs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Ivs" }, "java": { "package": "software.amazon.awscdk.services.ivs" }, "python": { "module": "aws_cdk.aws_ivs" } } }, "aws-cdk-lib.aws_ivschat": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IVSChat" }, "java": { "package": "software.amazon.awscdk.services.ivschat" }, "python": { "module": "aws_cdk.aws_ivschat" } } }, "aws-cdk-lib.aws_kafkaconnect": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KafkaConnect" }, "java": { "package": "software.amazon.awscdk.services.kafkaconnect" }, "python": { "module": "aws_cdk.aws_kafkaconnect" } } }, "aws-cdk-lib.aws_kendra": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Kendra" }, "java": { "package": "software.amazon.awscdk.services.kendra" }, "python": { "module": "aws_cdk.aws_kendra" } } }, "aws-cdk-lib.aws_kendraranking": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KendraRanking" }, "java": { "package": "software.amazon.awscdk.services.kendraranking" }, "python": { "module": "aws_cdk.aws_kendraranking" } } }, "aws-cdk-lib.aws_kinesis": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Kinesis" }, "java": { "package": "software.amazon.awscdk.services.kinesis" }, "python": { "module": "aws_cdk.aws_kinesis" } } }, "aws-cdk-lib.aws_kinesisanalytics": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KinesisAnalytics" }, "java": { "package": "software.amazon.awscdk.services.kinesisanalytics" }, "python": { "module": "aws_cdk.aws_kinesisanalytics" } } }, "aws-cdk-lib.aws_kinesisanalyticsv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KinesisAnalyticsV2" }, "java": { "package": "software.amazon.awscdk.services.kinesisanalyticsv2" }, "python": { "module": "aws_cdk.aws_kinesisanalyticsv2" } } }, "aws-cdk-lib.aws_kinesisfirehose": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KinesisFirehose" }, "java": { "package": "software.amazon.awscdk.services.kinesisfirehose" }, "python": { "module": "aws_cdk.aws_kinesisfirehose" } } }, "aws-cdk-lib.aws_kinesisvideo": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KinesisVideo" }, "java": { "package": "software.amazon.awscdk.services.kinesisvideo" }, "python": { "module": "aws_cdk.aws_kinesisvideo" } } }, "aws-cdk-lib.aws_kms": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KMS" }, "java": { "package": "software.amazon.awscdk.services.kms" }, "python": { "module": "aws_cdk.aws_kms" } } }, "aws-cdk-lib.aws_lakeformation": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.LakeFormation" }, "java": { "package": "software.amazon.awscdk.services.lakeformation" }, "python": { "module": "aws_cdk.aws_lakeformation" } } }, "aws-cdk-lib.aws_lambda": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lambda" }, "java": { "package": "software.amazon.awscdk.services.lambda" }, "python": { "module": "aws_cdk.aws_lambda" } } }, "aws-cdk-lib.aws_lambda_destinations": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lambda.Destinations" }, "java": { "package": "software.amazon.awscdk.services.lambda.destinations" }, "python": { "module": "aws_cdk.aws_lambda_destinations" } } }, "aws-cdk-lib.aws_lambda_event_sources": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lambda.EventSources" }, "java": { "package": "software.amazon.awscdk.services.lambda.eventsources" }, "python": { "module": "aws_cdk.aws_lambda_event_sources" } } }, "aws-cdk-lib.aws_lambda_nodejs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lambda.Nodejs" }, "java": { "package": "software.amazon.awscdk.services.lambda.nodejs" }, "python": { "module": "aws_cdk.aws_lambda_nodejs" } } }, "aws-cdk-lib.aws_launchwizard": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.LaunchWizard" }, "java": { "package": "software.amazon.awscdk.services.launchwizard" }, "python": { "module": "aws_cdk.aws_launchwizard" } } }, "aws-cdk-lib.aws_lex": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lex" }, "java": { "package": "software.amazon.awscdk.services.lex" }, "python": { "module": "aws_cdk.aws_lex" } } }, "aws-cdk-lib.aws_licensemanager": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.LicenseManager" }, "java": { "package": "software.amazon.awscdk.services.licensemanager" }, "python": { "module": "aws_cdk.aws_licensemanager" } } }, "aws-cdk-lib.aws_lightsail": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lightsail" }, "java": { "package": "software.amazon.awscdk.services.lightsail" }, "python": { "module": "aws_cdk.aws_lightsail" } } }, "aws-cdk-lib.aws_location": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Location" }, "java": { "package": "software.amazon.awscdk.services.location" }, "python": { "module": "aws_cdk.aws_location" } } }, "aws-cdk-lib.aws_logs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Logs" }, "java": { "package": "software.amazon.awscdk.services.logs" }, "python": { "module": "aws_cdk.aws_logs" } } }, "aws-cdk-lib.aws_logs_destinations": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Logs.Destinations" }, "java": { "package": "software.amazon.awscdk.services.logs.destinations" }, "python": { "module": "aws_cdk.aws_logs_destinations" } } }, "aws-cdk-lib.aws_lookoutequipment": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.LookoutEquipment" }, "java": { "package": "software.amazon.awscdk.services.lookoutequipment" }, "python": { "module": "aws_cdk.aws_lookoutequipment" } } }, "aws-cdk-lib.aws_lookoutmetrics": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.LookoutMetrics" }, "java": { "package": "software.amazon.awscdk.services.lookoutmetrics" }, "python": { "module": "aws_cdk.aws_lookoutmetrics" } } }, "aws-cdk-lib.aws_lookoutvision": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.LookoutVision" }, "java": { "package": "software.amazon.awscdk.services.lookoutvision" }, "python": { "module": "aws_cdk.aws_lookoutvision" } } }, "aws-cdk-lib.aws_m2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.M2" }, "java": { "package": "software.amazon.awscdk.services.m2" }, "python": { "module": "aws_cdk.aws_m2" } } }, "aws-cdk-lib.aws_macie": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Macie" }, "java": { "package": "software.amazon.awscdk.services.macie" }, "python": { "module": "aws_cdk.aws_macie" } } }, "aws-cdk-lib.aws_managedblockchain": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ManagedBlockchain" }, "java": { "package": "software.amazon.awscdk.services.managedblockchain" }, "python": { "module": "aws_cdk.aws_managedblockchain" } } }, "aws-cdk-lib.aws_mediaconnect": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaConnect" }, "java": { "package": "software.amazon.awscdk.services.mediaconnect" }, "python": { "module": "aws_cdk.aws_mediaconnect" } } }, "aws-cdk-lib.aws_mediaconvert": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaConvert" }, "java": { "package": "software.amazon.awscdk.services.mediaconvert" }, "python": { "module": "aws_cdk.aws_mediaconvert" } } }, "aws-cdk-lib.aws_medialive": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaLive" }, "java": { "package": "software.amazon.awscdk.services.medialive" }, "python": { "module": "aws_cdk.aws_medialive" } } }, "aws-cdk-lib.aws_mediapackage": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaPackage" }, "java": { "package": "software.amazon.awscdk.services.mediapackage" }, "python": { "module": "aws_cdk.aws_mediapackage" } } }, "aws-cdk-lib.aws_mediapackagev2": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.MediaPackageV2" }, "java": { "package": "software.amazon.awscdk.services.mediapackagev2" }, "python": { "module": "aws_cdk.aws_mediapackagev2" } } }, "aws-cdk-lib.aws_mediastore": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaStore" }, "java": { "package": "software.amazon.awscdk.services.mediastore" }, "python": { "module": "aws_cdk.aws_mediastore" } } }, "aws-cdk-lib.aws_mediatailor": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaTailor" }, "java": { "package": "software.amazon.awscdk.services.mediatailor" }, "python": { "module": "aws_cdk.aws_mediatailor" } } }, "aws-cdk-lib.aws_memorydb": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MemoryDB" }, "java": { "package": "software.amazon.awscdk.services.memorydb" }, "python": { "module": "aws_cdk.aws_memorydb" } } }, "aws-cdk-lib.aws_msk": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MSK" }, "java": { "package": "software.amazon.awscdk.services.msk" }, "python": { "module": "aws_cdk.aws_msk" } } }, "aws-cdk-lib.aws_mwaa": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MWAA" }, "java": { "package": "software.amazon.awscdk.services.mwaa" }, "python": { "module": "aws_cdk.aws_mwaa" } } }, "aws-cdk-lib.aws_neptune": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Neptune" }, "java": { "package": "software.amazon.awscdk.services.neptune" }, "python": { "module": "aws_cdk.aws_neptune" } } }, "aws-cdk-lib.aws_neptunegraph": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.NeptuneGraph" }, "java": { "package": "software.amazon.awscdk.services.neptunegraph" }, "python": { "module": "aws_cdk.aws_neptunegraph" } } }, "aws-cdk-lib.aws_networkfirewall": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.NetworkFirewall" }, "java": { "package": "software.amazon.awscdk.services.networkfirewall" }, "python": { "module": "aws_cdk.aws_networkfirewall" } } }, "aws-cdk-lib.aws_networkmanager": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.NetworkManager" }, "java": { "package": "software.amazon.awscdk.services.networkmanager" }, "python": { "module": "aws_cdk.aws_networkmanager" } } }, "aws-cdk-lib.aws_nimblestudio": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.NimbleStudio" }, "java": { "package": "software.amazon.awscdk.services.nimblestudio" }, "python": { "module": "aws_cdk.aws_nimblestudio" } } }, "aws-cdk-lib.aws_oam": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Oam" }, "java": { "package": "software.amazon.awscdk.services.oam" }, "python": { "module": "aws_cdk.aws_oam" } } }, "aws-cdk-lib.aws_omics": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Omics" }, "java": { "package": "software.amazon.awscdk.services.omics" }, "python": { "module": "aws_cdk.aws_omics" } } }, "aws-cdk-lib.aws_opensearchserverless": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.OpenSearchServerless" }, "java": { "package": "software.amazon.awscdk.services.opensearchserverless" }, "python": { "module": "aws_cdk.aws_opensearchserverless" } } }, "aws-cdk-lib.aws_opensearchservice": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.OpenSearchService" }, "java": { "package": "software.amazon.awscdk.services.opensearchservice" }, "python": { "module": "aws_cdk.aws_opensearchservice" } } }, "aws-cdk-lib.aws_opsworks": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.OpsWorks" }, "java": { "package": "software.amazon.awscdk.services.opsworks" }, "python": { "module": "aws_cdk.aws_opsworks" } } }, "aws-cdk-lib.aws_opsworkscm": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.OpsWorksCM" }, "java": { "package": "software.amazon.awscdk.services.opsworkscm" }, "python": { "module": "aws_cdk.aws_opsworkscm" } } }, "aws-cdk-lib.aws_organizations": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Organizations" }, "java": { "package": "software.amazon.awscdk.services.organizations" }, "python": { "module": "aws_cdk.aws_organizations" } } }, "aws-cdk-lib.aws_osis": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.OSIS" }, "java": { "package": "software.amazon.awscdk.services.osis" }, "python": { "module": "aws_cdk.aws_osis" } } }, "aws-cdk-lib.aws_panorama": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Panorama" }, "java": { "package": "software.amazon.awscdk.services.panorama" }, "python": { "module": "aws_cdk.aws_panorama" } } }, "aws-cdk-lib.aws_paymentcryptography": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.PaymentCryptography" }, "java": { "package": "software.amazon.awscdk.services.paymentcryptography" }, "python": { "module": "aws_cdk.aws_paymentcryptography" } } }, "aws-cdk-lib.aws_pcaconnectorad": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.PCAConnectorAD" }, "java": { "package": "software.amazon.awscdk.services.pcaconnectorad" }, "python": { "module": "aws_cdk.aws_pcaconnectorad" } } }, "aws-cdk-lib.aws_pcaconnectorscep": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.PCAConnectorSCEP" }, "java": { "package": "software.amazon.awscdk.services.pcaconnectorscep" }, "python": { "module": "aws_cdk.aws_pcaconnectorscep" } } }, "aws-cdk-lib.aws_personalize": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Personalize" }, "java": { "package": "software.amazon.awscdk.services.personalize" }, "python": { "module": "aws_cdk.aws_personalize" } } }, "aws-cdk-lib.aws_pinpoint": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Pinpoint" }, "java": { "package": "software.amazon.awscdk.services.pinpoint" }, "python": { "module": "aws_cdk.aws_pinpoint" } } }, "aws-cdk-lib.aws_pinpointemail": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.PinpointEmail" }, "java": { "package": "software.amazon.awscdk.services.pinpointemail" }, "python": { "module": "aws_cdk.aws_pinpointemail" } } }, "aws-cdk-lib.aws_pipes": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Pipes" }, "java": { "package": "software.amazon.awscdk.services.pipes" }, "python": { "module": "aws_cdk.aws_pipes" } } }, "aws-cdk-lib.aws_proton": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.Proton" }, "java": { "package": "software.amazon.awscdk.services.proton" }, "python": { "module": "aws_cdk.aws_proton" } } }, "aws-cdk-lib.aws_qbusiness": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.QBusiness" }, "java": { "package": "software.amazon.awscdk.services.qbusiness" }, "python": { "module": "aws_cdk.aws_qbusiness" } } }, "aws-cdk-lib.aws_qldb": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.QLDB" }, "java": { "package": "software.amazon.awscdk.services.qldb" }, "python": { "module": "aws_cdk.aws_qldb" } } }, "aws-cdk-lib.aws_quicksight": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.QuickSight" }, "java": { "package": "software.amazon.awscdk.services.quicksight" }, "python": { "module": "aws_cdk.aws_quicksight" } } }, "aws-cdk-lib.aws_ram": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RAM" }, "java": { "package": "software.amazon.awscdk.services.ram" }, "python": { "module": "aws_cdk.aws_ram" } } }, "aws-cdk-lib.aws_rds": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RDS" }, "java": { "package": "software.amazon.awscdk.services.rds" }, "python": { "module": "aws_cdk.aws_rds" } } }, "aws-cdk-lib.aws_redshift": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Redshift" }, "java": { "package": "software.amazon.awscdk.services.redshift" }, "python": { "module": "aws_cdk.aws_redshift" } } }, "aws-cdk-lib.aws_redshiftserverless": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RedshiftServerless" }, "java": { "package": "software.amazon.awscdk.services.redshiftserverless" }, "python": { "module": "aws_cdk.aws_redshiftserverless" } } }, "aws-cdk-lib.aws_refactorspaces": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RefactorSpaces" }, "java": { "package": "software.amazon.awscdk.services.refactorspaces" }, "python": { "module": "aws_cdk.aws_refactorspaces" } } }, "aws-cdk-lib.aws_rekognition": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Rekognition" }, "java": { "package": "software.amazon.awscdk.services.rekognition" }, "python": { "module": "aws_cdk.aws_rekognition" } } }, "aws-cdk-lib.aws_resiliencehub": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ResilienceHub" }, "java": { "package": "software.amazon.awscdk.services.resiliencehub" }, "python": { "module": "aws_cdk.aws_resiliencehub" } } }, "aws-cdk-lib.aws_resourceexplorer2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ResourceExplorer2" }, "java": { "package": "software.amazon.awscdk.services.resourceexplorer2" }, "python": { "module": "aws_cdk.aws_resourceexplorer2" } } }, "aws-cdk-lib.aws_resourcegroups": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ResourceGroups" }, "java": { "package": "software.amazon.awscdk.services.resourcegroups" }, "python": { "module": "aws_cdk.aws_resourcegroups" } } }, "aws-cdk-lib.aws_robomaker": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RoboMaker" }, "java": { "package": "software.amazon.awscdk.services.robomaker" }, "python": { "module": "aws_cdk.aws_robomaker" } } }, "aws-cdk-lib.aws_rolesanywhere": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RolesAnywhere" }, "java": { "package": "software.amazon.awscdk.services.rolesanywhere" }, "python": { "module": "aws_cdk.aws_rolesanywhere" } } }, "aws-cdk-lib.aws_route53": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53" }, "java": { "package": "software.amazon.awscdk.services.route53" }, "python": { "module": "aws_cdk.aws_route53" } } }, "aws-cdk-lib.aws_route53_patterns": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53.Patterns" }, "java": { "package": "software.amazon.awscdk.services.route53.patterns" }, "python": { "module": "aws_cdk.aws_route53_patterns" } } }, "aws-cdk-lib.aws_route53_targets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53.Targets" }, "java": { "package": "software.amazon.awscdk.services.route53.targets" }, "python": { "module": "aws_cdk.aws_route53_targets" } } }, "aws-cdk-lib.aws_route53profiles": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.Route53Profiles" }, "java": { "package": "software.amazon.awscdk.services.route53profiles" }, "python": { "module": "aws_cdk.aws_route53profiles" } } }, "aws-cdk-lib.aws_route53recoverycontrol": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53RecoveryControl" }, "java": { "package": "software.amazon.awscdk.services.route53recoverycontrol" }, "python": { "module": "aws_cdk.aws_route53recoverycontrol" } } }, "aws-cdk-lib.aws_route53recoveryreadiness": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53RecoveryReadiness" }, "java": { "package": "software.amazon.awscdk.services.route53recoveryreadiness" }, "python": { "module": "aws_cdk.aws_route53recoveryreadiness" } } }, "aws-cdk-lib.aws_route53resolver": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53Resolver" }, "java": { "package": "software.amazon.awscdk.services.route53resolver" }, "python": { "module": "aws_cdk.aws_route53resolver" } } }, "aws-cdk-lib.aws_rum": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RUM" }, "java": { "package": "software.amazon.awscdk.services.rum" }, "python": { "module": "aws_cdk.aws_rum" } } }, "aws-cdk-lib.aws_s3": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3" }, "java": { "package": "software.amazon.awscdk.services.s3" }, "python": { "module": "aws_cdk.aws_s3" } } }, "aws-cdk-lib.aws_s3_assets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3.Assets" }, "java": { "package": "software.amazon.awscdk.services.s3.assets" }, "python": { "module": "aws_cdk.aws_s3_assets" } } }, "aws-cdk-lib.aws_s3_deployment": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3.Deployment" }, "java": { "package": "software.amazon.awscdk.services.s3.deployment" }, "python": { "module": "aws_cdk.aws_s3_deployment" } } }, "aws-cdk-lib.aws_s3_notifications": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3.Notifications" }, "java": { "package": "software.amazon.awscdk.services.s3.notifications" }, "python": { "module": "aws_cdk.aws_s3_notifications" } } }, "aws-cdk-lib.aws_s3express": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.S3Express" }, "java": { "package": "software.amazon.awscdk.services.s3express" }, "python": { "module": "aws_cdk.aws_s3express" } } }, "aws-cdk-lib.aws_s3objectlambda": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3ObjectLambda" }, "java": { "package": "software.amazon.awscdk.services.s3objectlambda" }, "python": { "module": "aws_cdk.aws_s3objectlambda" } } }, "aws-cdk-lib.aws_s3outposts": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3Outposts" }, "java": { "package": "software.amazon.awscdk.services.s3outposts" }, "python": { "module": "aws_cdk.aws_s3outposts" } } }, "aws-cdk-lib.aws_sagemaker": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Sagemaker" }, "java": { "package": "software.amazon.awscdk.services.sagemaker" }, "python": { "module": "aws_cdk.aws_sagemaker" } } }, "aws-cdk-lib.aws_sam": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SAM" }, "java": { "package": "software.amazon.awscdk.services.sam" }, "python": { "module": "aws_cdk.aws_sam" } } }, "aws-cdk-lib.aws_scheduler": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Scheduler" }, "java": { "package": "software.amazon.awscdk.services.scheduler" }, "python": { "module": "aws_cdk.aws_scheduler" } } }, "aws-cdk-lib.aws_sdb": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SDB" }, "java": { "package": "software.amazon.awscdk.services.sdb" }, "python": { "module": "aws_cdk.aws_sdb" } } }, "aws-cdk-lib.aws_secretsmanager": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SecretsManager" }, "java": { "package": "software.amazon.awscdk.services.secretsmanager" }, "python": { "module": "aws_cdk.aws_secretsmanager" } } }, "aws-cdk-lib.aws_securityhub": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SecurityHub" }, "java": { "package": "software.amazon.awscdk.services.securityhub" }, "python": { "module": "aws_cdk.aws_securityhub" } } }, "aws-cdk-lib.aws_securitylake": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.SecurityLake" }, "java": { "package": "software.amazon.awscdk.services.securitylake" }, "python": { "module": "aws_cdk.aws_securitylake" } } }, "aws-cdk-lib.aws_servicecatalog": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Servicecatalog" }, "java": { "package": "software.amazon.awscdk.services.servicecatalog" }, "python": { "module": "aws_cdk.aws_servicecatalog" } } }, "aws-cdk-lib.aws_servicecatalogappregistry": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Servicecatalogappregistry" }, "java": { "package": "software.amazon.awscdk.services.servicecatalogappregistry" }, "python": { "module": "aws_cdk.aws_servicecatalogappregistry" } } }, "aws-cdk-lib.aws_servicediscovery": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ServiceDiscovery" }, "java": { "package": "software.amazon.awscdk.services.servicediscovery" }, "python": { "module": "aws_cdk.aws_servicediscovery" } } }, "aws-cdk-lib.aws_ses": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SES" }, "java": { "package": "software.amazon.awscdk.services.ses" }, "python": { "module": "aws_cdk.aws_ses" } } }, "aws-cdk-lib.aws_ses_actions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SES.Actions" }, "java": { "package": "software.amazon.awscdk.services.ses.actions" }, "python": { "module": "aws_cdk.aws_ses_actions" } } }, "aws-cdk-lib.aws_shield": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.Shield" }, "java": { "package": "software.amazon.awscdk.services.shield" }, "python": { "module": "aws_cdk.aws_shield" } } }, "aws-cdk-lib.aws_signer": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Signer" }, "java": { "package": "software.amazon.awscdk.services.signer" }, "python": { "module": "aws_cdk.aws_signer" } } }, "aws-cdk-lib.aws_simspaceweaver": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SimSpaceWeaver" }, "java": { "package": "software.amazon.awscdk.services.simspaceweaver" }, "python": { "module": "aws_cdk.aws_simspaceweaver" } } }, "aws-cdk-lib.aws_sns": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SNS" }, "java": { "package": "software.amazon.awscdk.services.sns" }, "python": { "module": "aws_cdk.aws_sns" } } }, "aws-cdk-lib.aws_sns_subscriptions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SNS.Subscriptions" }, "java": { "package": "software.amazon.awscdk.services.sns.subscriptions" }, "python": { "module": "aws_cdk.aws_sns_subscriptions" } } }, "aws-cdk-lib.aws_sqs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SQS" }, "java": { "package": "software.amazon.awscdk.services.sqs" }, "python": { "module": "aws_cdk.aws_sqs" } } }, "aws-cdk-lib.aws_ssm": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SSM" }, "java": { "package": "software.amazon.awscdk.services.ssm" }, "python": { "module": "aws_cdk.aws_ssm" } } }, "aws-cdk-lib.aws_ssmcontacts": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SSMContacts" }, "java": { "package": "software.amazon.awscdk.services.ssmcontacts" }, "python": { "module": "aws_cdk.aws_ssmcontacts" } } }, "aws-cdk-lib.aws_ssmincidents": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SSMIncidents" }, "java": { "package": "software.amazon.awscdk.services.ssmincidents" }, "python": { "module": "aws_cdk.aws_ssmincidents" } } }, "aws-cdk-lib.aws_ssmquicksetup": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.SSMQuickSetup" }, "java": { "package": "software.amazon.awscdk.services.ssmquicksetup" }, "python": { "module": "aws_cdk.aws_ssmquicksetup" } } }, "aws-cdk-lib.aws_sso": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SSO" }, "java": { "package": "software.amazon.awscdk.services.sso" }, "python": { "module": "aws_cdk.aws_sso" } } }, "aws-cdk-lib.aws_stepfunctions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.StepFunctions" }, "java": { "package": "software.amazon.awscdk.services.stepfunctions" }, "python": { "module": "aws_cdk.aws_stepfunctions" } } }, "aws-cdk-lib.aws_stepfunctions_tasks": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.StepFunctions.Tasks" }, "java": { "package": "software.amazon.awscdk.services.stepfunctions.tasks" }, "python": { "module": "aws_cdk.aws_stepfunctions_tasks" } } }, "aws-cdk-lib.aws_supportapp": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SupportApp" }, "java": { "package": "software.amazon.awscdk.services.supportapp" }, "python": { "module": "aws_cdk.aws_supportapp" } } }, "aws-cdk-lib.aws_synthetics": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Synthetics" }, "java": { "package": "software.amazon.awscdk.services.synthetics" }, "python": { "module": "aws_cdk.aws_synthetics" } } }, "aws-cdk-lib.aws_systemsmanagersap": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SystemsManagerSAP" }, "java": { "package": "software.amazon.awscdk.services.systemsmanagersap" }, "python": { "module": "aws_cdk.aws_systemsmanagersap" } } }, "aws-cdk-lib.aws_timestream": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Timestream" }, "java": { "package": "software.amazon.awscdk.services.timestream" }, "python": { "module": "aws_cdk.aws_timestream" } } }, "aws-cdk-lib.aws_transfer": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Transfer" }, "java": { "package": "software.amazon.awscdk.services.transfer" }, "python": { "module": "aws_cdk.aws_transfer" } } }, "aws-cdk-lib.aws_verifiedpermissions": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.VerifiedPermissions" }, "java": { "package": "software.amazon.awscdk.services.verifiedpermissions" }, "python": { "module": "aws_cdk.aws_verifiedpermissions" } } }, "aws-cdk-lib.aws_voiceid": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.VoiceID" }, "java": { "package": "software.amazon.awscdk.services.voiceid" }, "python": { "module": "aws_cdk.aws_voiceid" } } }, "aws-cdk-lib.aws_vpclattice": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.VpcLattice" }, "java": { "package": "software.amazon.awscdk.services.vpclattice" }, "python": { "module": "aws_cdk.aws_vpclattice" } } }, "aws-cdk-lib.aws_waf": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.WAF" }, "java": { "package": "software.amazon.awscdk.services.waf" }, "python": { "module": "aws_cdk.aws_waf" } } }, "aws-cdk-lib.aws_wafregional": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.WAFRegional" }, "java": { "package": "software.amazon.awscdk.services.waf.regional" }, "python": { "module": "aws_cdk.aws_wafregional" } } }, "aws-cdk-lib.aws_wafv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.WAFv2" }, "java": { "package": "software.amazon.awscdk.services.wafv2" }, "python": { "module": "aws_cdk.aws_wafv2" } } }, "aws-cdk-lib.aws_wisdom": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Wisdom" }, "java": { "package": "software.amazon.awscdk.services.wisdom" }, "python": { "module": "aws_cdk.aws_wisdom" } } }, "aws-cdk-lib.aws_workspaces": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.WorkSpaces" }, "java": { "package": "software.amazon.awscdk.services.workspaces" }, "python": { "module": "aws_cdk.aws_workspaces" } } }, "aws-cdk-lib.aws_workspacesthinclient": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.WorkSpacesThinClient" }, "java": { "package": "software.amazon.awscdk.services.workspacesthinclient" }, "python": { "module": "aws_cdk.aws_workspacesthinclient" } } }, "aws-cdk-lib.aws_workspacesweb": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.WorkSpacesWeb" }, "java": { "package": "software.amazon.awscdk.services.workspacesweb" }, "python": { "module": "aws_cdk.aws_workspacesweb" } } }, "aws-cdk-lib.aws_xray": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.XRay" }, "java": { "package": "software.amazon.awscdk.services.xray" }, "python": { "module": "aws_cdk.aws_xray" } } }, "aws-cdk-lib.cloud_assembly_schema": {}, "aws-cdk-lib.cloudformation_include": { "targets": { "dotnet": { "namespace": "Amazon.CDK.CloudFormation.Include" }, "java": { "package": "software.amazon.awscdk.cloudformation.include" }, "python": { "module": "aws_cdk.cloudformation_include" } } }, "aws-cdk-lib.custom_resources": { "targets": { "dotnet": { "namespace": "Amazon.CDK.CustomResources" }, "java": { "package": "software.amazon.awscdk.customresources" }, "python": { "module": "aws_cdk.custom_resources" } } }, "aws-cdk-lib.cx_api": { "targets": { "dotnet": { "namespace": "Amazon.CDK.CXAPI" }, "java": { "package": "software.amazon.awscdk.cxapi" }, "python": { "module": "aws_cdk.cx_api" } } }, "aws-cdk-lib.lambda_layer_awscli": { "targets": { "dotnet": { "namespace": "Amazon.CDK.LambdaLayer.AwsCli" }, "java": { "package": "software.amazon.awscdk.lambdalayer.awscli" }, "python": { "module": "aws_cdk.lambda_layer_awscli" } } }, "aws-cdk-lib.lambda_layer_kubectl": { "targets": { "dotnet": { "namespace": "Amazon.CDK.LambdaLayer.Kubectl" }, "java": { "package": "software.amazon.awscdk.lambdalayer.kubectl" }, "python": { "module": "aws_cdk.lambda_layer_kubectl" } } }, "aws-cdk-lib.lambda_layer_node_proxy_agent": { "targets": { "dotnet": { "namespace": "Amazon.CDK.LambdaLayer.NodeProxyAgent" }, "java": { "package": "software.amazon.awscdk.lambda.layer.node.proxy.agent" }, "python": { "module": "aws_cdk.lambda_layer_node_proxy_agent" } } }, "aws-cdk-lib.pipelines": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Pipelines" }, "java": { "package": "software.amazon.awscdk.pipelines" }, "python": { "module": "aws_cdk.pipelines" } } }, "aws-cdk-lib.region_info": { "targets": { "dotnet": { "namespace": "Amazon.CDK.RegionInfo" }, "java": { "package": "software.amazon.awscdk.regioninfo" }, "python": { "module": "aws_cdk.region_info" } } }, "aws-cdk-lib.triggers": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Triggers" }, "java": { "package": "software.amazon.awscdk.triggers" }, "python": { "module": "aws_cdk.triggers" } } } }, "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/main/logo/default-256-dark.png", "namespace": "Amazon.CDK", "packageId": "Amazon.CDK.Lib" }, "go": { "moduleName": "github.com/aws/aws-cdk-go", "packageName": "awscdk" }, "java": { "maven": { "artifactId": "aws-cdk-lib", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk" }, "js": { "npm": "aws-cdk-lib" }, "python": { "distName": "aws-cdk-lib", "module": "aws_cdk" } } }, "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": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "homepage": "https://github.com/cdklabs/cdk-monitoring-constructs", "jsiiVersion": "5.9.44 (build 150b837)", "keywords": [ "cdk", "cloudwatch", "monitoring" ], "license": "Apache-2.0", "metadata": { "jsii": { "pacmak": { "hasDefaultInterfaces": true } }, "tscRootDir": "lib" }, "name": "cdk-monitoring-constructs", "readme": { "markdown": "# CDK Monitoring Constructs\n\n[![NPM version](https://badge.fury.io/js/cdk-monitoring-constructs.svg)](https://badge.fury.io/js/cdk-monitoring-constructs)\n[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.github.cdklabs/cdkmonitoringconstructs/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.github.cdklabs/cdkmonitoringconstructs)\n[![PyPI version](https://badge.fury.io/py/cdk-monitoring-constructs.svg)](https://badge.fury.io/py/cdk-monitoring-constructs)\n[![NuGet version](https://badge.fury.io/nu/Cdklabs.CdkMonitoringConstructs.svg)](https://badge.fury.io/nu/Cdklabs.CdkMonitoringConstructs)\n[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/cdklabs/cdk-monitoring-constructs)\n[![Mergify](https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/cdklabs/cdk-monitoring-constructs&style=flat)](https://mergify.io)\n\nEasy-to-use CDK constructs for monitoring your AWS infrastructure with [Amazon CloudWatch](https://aws.amazon.com/cloudwatch/).\n\n- Easily add commonly-used alarms using predefined properties\n- Generate concise CloudWatch dashboards that indicate your alarms\n- Extend the library with your own extensions or custom metrics\n- Consume the library in multiple supported languages\n\n## Installation\n\n
TypeScript\n\n> \n\nIn your `package.json`:\n\n```json\n{\n \"dependencies\": {\n \"cdk-monitoring-constructs\": \"^9.0.0\",\n\n // peer dependencies of cdk-monitoring-constructs\n \"aws-cdk-lib\": \"^2.160.0\",\n \"constructs\": \"^10.0.5\"\n\n // ...your other dependencies...\n }\n}\n```\n\n
\n\n
Java\n\nSee \n\n
\n\n
Python\n\nSee \n\n
\n\n
C#\n\nSee \n\n
\n\n## Features\n\nYou can browse the documentation at \n\n| Item | Monitoring | Alarms | Notes |\n| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| AWS API Gateway (REST API) (`.monitorApiGateway()`) | TPS, latency, errors | Latency, error count/rate, low/high TPS | To see metrics, you have to enable Advanced Monitoring |\n| AWS API Gateway V2 (HTTP API) (`.monitorApiGatewayV2HttpApi()`) | TPS, latency, errors | Latency, error count/rate, low/high TPS | To see route level metrics, you have to enable Advanced Monitoring |\n| AWS AppSync (GraphQL API) (`.monitorAppSyncApi()`) | TPS, latency, errors | Latency, error count/rate, low/high TPS | |\n| Amazon Aurora (`.monitorAuroraCluster()`) | Query duration, connections, latency, CPU usage, Serverless Database Capacity | Connections, Serverless Database Capacity and CPU usage | |\n| AWS Billing (`.monitorBilling()`) | AWS account cost | Total cost (anomaly) | [Requires enabling](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/gs_monitor_estimated_charges_with_cloudwatch.html#gs_turning_on_billing_metrics) the **Receive Billing Alerts** option in AWS Console / Billing Preferences |\n| AWS Certificate Manager (`.monitorCertificate()`) | Certificate expiration | Days until expiration | |\n| AWS CloudFront (`.monitorCloudFrontDistribution()`) | TPS, traffic, latency, errors | Error rate, low/high TPS | |\n| AWS CloudWatch Logs (`.monitorLog()`) | Patterns present in the log group | Minimum incoming logs | |\n| AWS CloudWatch Synthetics Canary (`.monitorSyntheticsCanary()`) | Latency, error count/rate | Error count/rate, latency | |\n| AWS CodeBuild (`.monitorCodeBuildProject()`) | Build counts (total, successful, failed), failed rate, duration | Failed build count/rate, duration | |\n| AWS DocumentDB (`.monitorDocumentDbCluster()`) | CPU, throttling, read/write latency, transactions, cursors | CPU | |\n| AWS DynamoDB (`.monitorDynamoTable()`) | Read and write capacity provisioned / used | Consumed capacity, throttling, latency, errors | |\n| AWS DynamoDB Global Secondary Index (`.monitorDynamoTableGlobalSecondaryIndex()`) | Read and write capacity, indexing progress, throttled events | | |\n| AWS EC2 (`.monitorEC2Instances()`) | CPU, disk operations, network | | |\n| AWS EC2 Auto Scaling Groups (`.monitorAutoScalingGroup()`) | Group size, instance status | | |\n| AWS ECS (`.monitorFargateService()`, `.monitorEc2Service()`, `.monitorSimpleFargateService()`, `monitorSimpleEc2Service()`, `.monitorQueueProcessingFargateService()`, `.monitorQueueProcessingEc2Service()`) | System resources and task health | Unhealthy task count, running tasks count, CPU/memory usage, and bytes processed by load balancer (if any) | Use for ecs-patterns load balanced ec2/fargate constructs (NetworkLoadBalancedEc2Service, NetworkLoadBalancedFargateService, ApplicationLoadBalancedEc2Service, ApplicationLoadBalancedFargateService) |\n| AWS ElastiCache (`.monitorElastiCacheCluster()`) | CPU/memory usage, evictions and connections | CPU, memory, items count | |\n| AWS Glue (`.monitorGlueJob()`) | Traffic, job status, memory/CPU usage | Failed/killed task count/rate | |\n| AWS Kinesis Data Analytics (`.monitorKinesisDataAnalytics`) | Up/Downtime, CPU/memory usage, KPU usage, checkpoint metrics, and garbage collection metrics | Downtime, full restart count | |\n| AWS Kinesis Data Stream (`.monitorKinesisDataStream()`) | Put/Get/Incoming Record/s and Throttling | Throttling, throughput, iterator max age | |\n| AWS Kinesis Firehose (`.monitorKinesisFirehose()`) | Number of records, requests, latency, throttling | Throttling | |\n| AWS Lambda (`.monitorLambdaFunction()`) | Latency, errors, iterator max age | Latency, errors, throttles, iterator max age | Optional Lambda Insights metrics (opt-in) support |\n| AWS Load Balancing (`.monitorNetworkLoadBalancer()`, `.monitorFargateApplicationLoadBalancer()`, `.monitorFargateNetworkLoadBalancer()`, `.monitorEc2ApplicationLoadBalancer()`, `.monitorEc2NetworkLoadBalancer()`) | System resources and task health | Unhealthy task count, running tasks count, (for Fargate/Ec2 apps) CPU/memory usage | Use for FargateService or Ec2Service backed by a NetworkLoadBalancer or ApplicationLoadBalancer |\n| AWS OpenSearch/Elasticsearch (`.monitorOpenSearchCluster()`, `.monitorElasticsearchCluster()`) | Indexing and search latency, disk/memory/CPU usage | Indexing and search latency, disk/memory/CPU usage, cluster status, KMS keys | |\n| AWS OpenSearch Ingestion (`.monitorOpenSearchIngestionPipeline()`) | Latency, incoming data, DLQ records count | DLQ records count | |\n| AWS OpenSearch Serverless (`.monitorOpenSearchServerlessCollection()`) | Search latency, errors, ingestion requests/latency | Search latency, errors | |\n| AWS OpenSearch Serverless (`.monitorOpenSearchServerlessIndex()`) | Documents count | | |\n| AWS RDS (`.monitorRdsCluster()`) | Query duration, connections, latency, disk/CPU usage | Connections, disk and CPU usage | |\n| AWS RDS (`.monitorRdsInstance()`) | Query duration, connections, latency, disk/CPU usage | Connections, disk and CPU usage | |\n| AWS Redshift (`.monitorRedshiftCluster()`) | Query duration, connections, latency, disk/CPU usage | Query duration, connections, disk and CPU usage | |\n| AWS S3 Bucket (`.monitorS3Bucket()`) | Bucket size and number of objects | | |\n| AWS SecretsManager (`.monitorSecretsManager()`) | Max secret count, min secret sount, secret count change | Min/max secret count or change in secret count | |\n| AWS SecretsManager Secret (`.monitorSecretsManagerSecret()`) | Days since last rotation | Days since last change or rotation | |\n| AWS SNS Topic (`.monitorSnsTopic()`) | Message count, size, failed notifications | Failed notifications, min/max published messages | |\n| AWS SQS Queue (`.monitorSqsQueue()`, `.monitorSqsQueueWithDlq()`) | Message count, age, size | Message count, age, DLQ incoming messages | |\n| AWS Step Functions (`.monitorStepFunction()`, `.monitorStepFunctionActivity()`, `monitorStepFunctionLambdaIntegration()`, `.monitorStepFunctionServiceIntegration()`) | Execution count and breakdown per state | Duration, failed, failed rate, aborted, throttled, timed out executions | |\n| AWS Web Application Firewall (`.monitorWebApplicationFirewallAclV2()`) | Allowed/blocked requests | Blocked requests count/rate | |\n| FluentBit (`.monitorFluentBit()`) | Num of input records, Output failures & retries, Filter metrics, Storage metrics | | FluentBit needs proper configuration with metrics enabled: [Official sample configuration](https://github.com/aws-samples/amazon-ecs-firelens-examples/tree/mainline/examples/fluent-bit/send-fb-internal-metrics-to-cw). This function creates MetricFilters to publish all FluentBit metrics. |\n| Custom metrics (`.monitorCustom()`) | Addition of custom metrics into the dashboard (each group is a widget) | | Supports anomaly detection |\n\n## Getting started\n\n### Create a facade\n\n_Important note_: **Please, do NOT import anything from the `/dist/lib` package.** This is unsupported and might break any time.\n\n1. Create an instance of `MonitoringFacade`, which is the main entrypoint.\n1. Call methods on the facade like `.monitorLambdaFunction()` and chain them together to define your monitors. You can also use methods to add your own widgets, headers of various sizes, and more.\n\nFor examples of monitoring different resources, refer to [the unit tests](https://github.com/cdklabs/cdk-monitoring-constructs/tree/main/test/monitoring).\n\n```ts nofixture\nexport interface MonitoringStackProps extends DeploymentStackProps {\n // ...\n}\n\n// This could be in the same stack as your resources, as a nested stack, or a separate stack as you see fit\nexport class MonitoringStack extends DeploymentStack {\n constructor(parent: App, name: string, props: MonitoringStackProps) {\n super(parent, name, props);\n\n const monitoring = new MonitoringFacade(this, \"Monitoring\", {\n // Defaults are provided for these, but they can be customized as desired\n metricFactoryDefaults: { ... },\n alarmFactoryDefaults: { ... },\n dashboardFactory: { ... },\n });\n\n // Monitor your resources\n monitoring\n .addLargeHeader(\"Storage\")\n .monitorDynamoTable({ /* Monitor a DynamoDB table */ })\n .monitorDynamoTable({ /* and a different table */ })\n .monitorLambdaFunction({ /* and a Lambda function */ })\n .monitorCustom({ /* and some arbitrary metrics in CloudWatch */ })\n // ... etc.\n }\n}\n```\n\n### Customize actions\n\nAlarms should have actions set up, otherwise they are not very useful.\n\nExample of notifying an SNS topic:\n\n```ts nofixture\ndeclare const onAlarmTopic: ITopic;\n\nconst monitoring = new MonitoringFacade(this, \"Monitoring\", {\n // ...other props\n alarmFactoryDefaults: {\n // ....other props\n action: new SnsAlarmActionStrategy({ onAlarmTopic }),\n },\n});\n```\n\nYou can override the default topic for any alarm like this:\n\n```ts nofixture\nmonitoring.monitorSomething(something, {\n addSomeAlarm: {\n Warning: {\n // ...other props\n threshold: 42,\n actionOverride: new SnsAlarmActionStrategy({ onAlarmTopic }),\n },\n },\n});\n```\n\nSupported actions can be found [here](https://github.com/cdklabs/cdk-monitoring-constructs/tree/main/lib/common/alarm/action), including SNS and Lambda.\n\nYou can also compose multiple actions using `multipleActions`:\n\n```ts nofixture\ndeclare const onAlarmTopic: ITopic;\ndeclare const onAlarmFunction: IFunction;\n\nconst action: IAlarmActionStrategy = multipleActions(\n notifySns(onAlarmTopic),\n triggerLambda(onAlarmFunction),\n);\n```\n\n### Custom metrics\n\nFor simply adding some custom metrics, you can use `.monitorCustom()` and specify your own title and metric groups.\nEach metric group will be rendered as a single graph widget, and all widgets will be placed next to each other.\nAll the widgets will have the same size, which is chosen based on the number of groups to maximize dashboard space usage.\n\nCustom metric monitoring can be created for simple metrics, simple metrics with anomaly detection and search metrics.\nThe first two also support alarming.\n\nBelow we are listing a couple of examples. Let us assume that there are three existing metric variables: `m1`, `m2`, `m3`.\nThey can either be created by hand (`new Metric({...})`) or (preferably) by using `metricFactory` (that can be obtained from facade).\nThe advantage of using the shared `metricFactory` is that you do not need to worry about period, etc.\n\n```ts nofixture\n// create metrics manually\nconst m1 = new Metric(/* ... */);\n```\n\n```ts nofixture\nconst metricFactory = monitoringFacade.createMetricFactory();\n\n// create metrics using metric factory\nconst m1 = metricFactory.createMetric(/* ... */);\n```\n\n#### Example: metric with anomaly detection\n\nIn this case, only one metric is supported.\nMultiple metrics cannot be rendered with anomaly detection in a single widget due to a CloudWatch limitation.\n\n```ts\nmonitorCustom({\n title: \"Metric with anomaly detection\",\n metricGroups: [\n {\n metric: m1,\n anomalyDetectionStandardDeviationToRender: 3,\n },\n ],\n});\n```\n\nAdding an alarm:\n\n```ts\nmonitorCustom({\n title: \"Metric with anomaly detection and alarm\",\n metricGroups: [\n {\n metric: m1,\n alarmFriendlyName: \"MetricWithAnomalyDetectionAlarm\",\n anomalyDetectionStandardDeviationToRender: 3,\n addAlarmOnAnomaly: {\n Warning: {\n standardDeviationForAlarm: 4,\n alarmWhenAboveTheBand: true,\n alarmWhenBelowTheBand: true,\n },\n },\n },\n ],\n});\n```\n\n#### Example: search metrics\n\n```ts\nmonitorCustom({\n title: \"Metric search\",\n metricGroups: [\n {\n searchQuery: \"My.Prefix.\",\n dimensionsMap: {\n FirstDimension: \"FirstDimensionValue\",\n // Allow any value for the given dimension (pardon the weird typing to satisfy DimensionsMap)\n SecondDimension: undefined as unknown as string,\n },\n statistic: MetricStatistic.SUM,\n },\n ],\n});\n```\n\nSearch metrics do not support setting an alarm, which is a CloudWatch limitation.\n\n### Route53 Health Checks\n\nRoute53 has [strict requirements](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/health-checks-types.html) as to which alarms are allowed to be referenced in Health Checks.\nYou adjust the metric for an alarm so that it can be used in a Route53 Health Checks as follows:\n\n```ts\nmonitoring.monitorSomething(something, {\n addSomeAlarm: {\n Warning: {\n // ...other props\n metricAdjuster: Route53HealthCheckMetricAdjuster.INSTANCE,\n },\n },\n});\n```\n\nThis will ensure the alarm can be used on a Route53 Health Check or otherwise throw an `Error` indicating why the alarm can't be used.\nIn order to easily find your Route53 Health Check alarms later on, you can apply a custom tag to them as follows:\n\n```ts nofixture\nimport { CfnHealthCheck } from \"aws-cdk-lib/aws-route53\";\n\nmonitoring.monitorSomething(something, {\n addSomeAlarm: {\n Warning: {\n // ...other props\n customTags: [\"route53-health-check\"],\n metricAdjuster: Route53HealthCheckMetricAdjuster.INSTANCE,\n },\n },\n});\n\nconst alarms = monitoring.createdAlarmsWithTag(\"route53-health-check\");\n\nconst healthChecks = alarms.map(({ alarm }) => {\n const id = getHealthCheckConstructId(alarm);\n\n return new CfnHealthCheck(scope, id, {\n healthCheckConfig: {\n // ...other props\n type: \"CLOUDWATCH_METRIC\",\n alarmIdentifier: {\n name: alarm.alarmName,\n region: alarm.stack.region,\n },\n },\n });\n});\n```\n\n### Custom monitoring segments\n\nIf you want even more flexibility, you can create your own segment.\n\nThis is a general procedure on how to do it:\n\n1. Extend the `Monitoring` class\n1. Override the `widgets()` method (and/or similar ones)\n1. Leverage the metric factory and alarm factory provided by the base class (you can create additional factories, if you will)\n1. Add all alarms to `.addAlarm()` so they are visible to the user and being placed on the alarm summary dashboard\n\nBoth of these monitoring base classes are dashboard segments, so you can add them to your monitoring by calling `.addSegment()` on the `MonitoringFacade`.\n\n### Modifying or omitting widgets from default dashboard segments\n\nWhile the dashboard widgets defined in the library are meant to cover most use cases, they might not be what you're looking for.\n\nTo modify the widgets:\n\n1. Extend the appropriate `Monitoring` class (e.g., `LambdaFunctionMonitoring` for `monitorLambdaFunction`) and override the relevant methods (e.g., `widgets`):\n\n ```ts nofixture\n export class MyCustomizedLambdaFunctionMonitoring extends LambdaFunctionMonitoring {\n widgets(): IWidget[] {\n return [\n // Whatever widgets you want instead of what LambdaFunctionMonitoring has\n ];\n }\n }\n ```\n\n1. Use the facade's `addSegment` method with your custom class:\n\n ```ts nofixture\n declare const facade: MonitoringFacade;\n\n facade.addSegment(\n new MyCustomizedLambdaFunctionMonitoring(facade, {\n // Props for LambdaFunctionMonitoring\n }),\n );\n ```\n\n### Custom dashboards\n\nIf you want _even_ more flexibility, you can take complete control over dashboard generation by leveraging dynamic dashboarding features. This allows you to create an arbitrary number of dashboards while configuring each of them separately. You can do this in three simple steps:\n\n1. Create a dynamic dashboard factory\n2. Create `IDynamicDashboardSegment` implementations\n3. Add Dynamic Segments to your `MonitoringFacade`\n\n#### Create a dynamic dashboard factory\n\nThe below code sample will generate two dashboards with the following names:\n\n- ExampleDashboards-HostedService\n- ExampleDashboards-Infrastructure\n\n```ts nofixture\n// create the dynamic dashboard factory.\nconst factory = new DynamicDashboardFactory(stack, \"DynamicDashboards\", {\n dashboardNamePrefix: \"ExampleDashboards\",\n dashboardConfigs: [\n // 'name' is the minimum required configuration\n { name: \"HostedService\" },\n // below is an example of additional dashboard-specific config options\n {\n name: \"Infrastructure\",\n range: Duration.hours(3),\n periodOverride: PeriodOverride.AUTO,\n renderingPreference: DashboardRenderingPreference.BITMAP_ONLY,\n },\n ],\n});\n```\n\n#### Create `IDynamicDashboardSegment` implementations\n\nFor each construct you want monitored, you will need to create an implementation of an `IDynamicDashboardSegment`. The following is a basic reference implementation as an example:\n\n```ts nofixture\nexport enum DashboardTypes {\n HostedService = \"HostedService\",\n Infrastructure = \"Infrastructure\",\n}\n\nclass ExampleSegment implements IDynamicDashboardSegment {\n widgetsForDashboard(name: string): IWidget[] {\n // this logic is what's responsible for allowing your dynamic segment to return\n // different widgets for different dashboards\n switch (name) {\n case DashboardTypes.HostedService:\n return [\n new TextWidget({\n markdown:\n \"This shows metrics for your service hosted on AWS Infrastructure\",\n }),\n ];\n case DashboardTypes.Infrastructure:\n return [\n new TextWidget({\n markdown:\n \"This shows metrics for the AWS Infrastructure supporting your hosted service\",\n }),\n ];\n default:\n throw new Error(\"Unexpected dashboard name!\");\n }\n }\n}\n```\n\n#### Add Dynamic Segments to MonitoringFacade\n\nWhen you have instances of an `IDynamicDashboardSegment` to use, they can be added to your dashboard like this:\n\n```ts nofixture\nmonitoring.addDynamicSegment(new ExampleSegment());\n```\n\nNow, this widget will be added to both dashboards and will show different content depending on the dashboard. Using the above example code, two dashboards will be generated with the following content:\n\n- Dashboard Name: \"ExampleDashboards-HostedService\"\n - Content: \"This shows metrics for your service hosted on AWS Infrastructure\"\n- Dashboard Name: \"ExampleDashboards-Infrastructure\"\n - Content: \"This shows metrics for the AWS Infrastructure supporting your hosted service\"\n\n### Cross-account cross-Region Dashboards\n\nFacades can be configured for different regions/accounts as a whole:\n\n```ts\nnew MonitoringFacade(stack, \"Monitoring\", {\n metricFactoryDefaults: {\n // Different region/account than what you're deploying to\n region: \"us-west-2\",\n account: \"01234567890\",\n },\n});\n```\n\nOr at a more granular level:\n\n```ts\nmonitoring\n .monitorDynamoTable({\n // Table from the same account/region\n table: Table.fromTableName(stack, \"ImportedTable\", \"MyTableName\"),\n })\n .monitorDynamoTable({\n // Table from another account/region\n table: Table.fromTableArn(\n stack,\n \"XaXrImportedTable\",\n \"arn:aws:dynamodb:us-west-2:01234567890:table/my-other-table\",\n ),\n region: \"us-west-2\",\n account: \"01234567890\",\n });\n```\n\nThe order of precedence of the region/account values is:\n\n1. The individual metric factory's props (e.g. via the `monitorDynamoTable` props).\n1. The facade's `metricFactoryDefaults` props.\n1. The region/account that the stack is deployed to.\n\nNote that while this allows for cross-account cross-Region dashboarding, cross-Region alarming is not supported by CloudWatch.\n\n### Monitoring scopes\n\nYou can monitor complete CDK construct scopes using an aspect. It will automatically discover all monitorable resources within the scope recursively and add them to your dashboard.\n\n```ts\nmonitoring.monitorScope(stack, {\n // With optional configuration\n lambda: {\n props: {\n addLatencyP50Alarm: {\n Critical: { maxLatency: Duration.seconds(10) },\n },\n },\n },\n\n // Some resources that aren't dependent on nodes (e.g. general metrics across instances/account) may be included\n // by default, which can be explicitly disabled.\n billing: { enabled: false },\n ec2: { enabled: false },\n elasticCache: { enabled: false },\n});\n```\n\n### Cloning alarms\n\nYou can also create alarms by cloning other alarms and applying a modification function.\nWhen given a list of alarms created using `MonitoringFacade`, the facade can apply a\nuser-supplied function on each, generating new alarms with customizations from the\nfunction.\n\n```ts nofixture\n// Clone alarms using a cloning-function\nconst criticalAlarms = monitoring.createdAlarmsWithDisambiguator(\"Critical\");\nconst clones = monitoring.cloneAlarms(criticalAlarms, (a) => {\n // Define a new alarm that has values inspired by the original alarm\n // Adjust some of those values using arbitrary, user-provided logic\n return {\n ...a.alarmDefinition.addAlarmProps,\n actionsEnabled: false,\n disambiguator: \"ClonedCritical\",\n alarmDescription: \"Cloned alarm of \" + a.alarmDescription,\n // Bump the threshold a bit\n threshold: a.alarmDefinition.addAlarmProps.threshold * 1.1,\n // Tighten the number of datapoints a bit\n datapointsToAlarm: a.alarmDefinition.datapointsToAlarm - 1,\n // Keep the same number of evaluation periods\n evaluationPeriods: a.alarmDefinition.evaluationPeriods,\n };\n});\n```\n\nThis technique is particularly useful when you are using alarms for multiple purposes.\nFor instance, you may want to ensure regressions that result in an SLA-breach are\nautomatically rolled back _before_ a ticketing action takes effect. This scheme uses\npairs of alarms for each metric: a conservative ticketing alarm and an aggressive\nrollback alarm.\n\nRather that specifying both alarms throughout your application, you can automatically\ncreate the companion alarms by cloning with a scaling function. This library provides a\n`ScaleFunction` implementation that can be configured with multiplication factors for\n`threshold`, `datapointsToAlarm`, and `evaluationPeriods`; scaling factors between 0.0\nand 1.0 will generate more aggressive alarms.\n\n```ts\n// Clone critical alarms using a tighting scaling function\nconst criticalAlarms = monitoring.createdAlarmsWithDisambiguator(\"Critical\");\nconst rollbackAlarms = monitoring.cloneAlarms(\n criticalAlarms,\n ScaleAlarms({\n disambiguator: \"Rollback\",\n thresholdMultiplier: 0.8,\n datapointsToAlarmMultiplier: 0.3,\n evaluationPeriodsMultiplier: 0.5,\n }),\n);\n```\n\n## Contributing\n\nSee [CONTRIBUTING](CONTRIBUTING.md) for more information.\n\n## Security policy\n\nSee [SECURITY](SECURITY.md) for more information.\n\n## License\n\nThis project is licensed under the Apache-2.0 License.\n" }, "repository": { "type": "git", "url": "https://github.com/cdklabs/cdk-monitoring-constructs" }, "schema": "jsii/0.10.0", "targets": { "dotnet": { "namespace": "Cdklabs.CdkMonitoringConstructs", "packageId": "Cdklabs.CdkMonitoringConstructs" }, "java": { "maven": { "artifactId": "cdkmonitoringconstructs", "groupId": "io.github.cdklabs" }, "package": "io.github.cdklabs.cdkmonitoringconstructs" }, "js": { "npm": "cdk-monitoring-constructs" }, "python": { "distName": "cdk-monitoring-constructs", "module": "cdk_monitoring_constructs" } }, "types": { "cdk-monitoring-constructs.AddAlarmProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Properties necessary to create a single alarm and configure it." }, "fqn": "cdk-monitoring-constructs.AddAlarmProps", "kind": "interface", "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 75 }, "name": "AddAlarmProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Alarm description is included in the ticket and therefore should describe what happened, with as much context as possible." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 114 }, "name": "alarmDescription", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Alarm names need to be unique.", "stability": "experimental", "summary": "Suffix added to base alarm name." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 133 }, "name": "alarmNameSuffix", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Comparison operator used to compare actual value against the threshold." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 159 }, "name": "comparisonOperator", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.ComparisonOperator" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Threshold to alarm on." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 154 }, "name": "threshold", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Behaviour in case the metric data is missing." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 164 }, "name": "treatMissingData", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData" } }, { "abstract": true, "docs": { "default": "- default action will be used", "stability": "experimental", "summary": "Allows to override the default action strategy." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 81 }, "name": "actionOverride", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.IAlarmActionStrategy" } }, { "abstract": true, "docs": { "default": "- the same as monitoring facade default", "stability": "experimental", "summary": "Enables the configured CloudWatch alarm ticketing actions." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 149 }, "name": "actionsEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- undefined (no suffix)", "remarks": "This allows you to specify the same dedupe string for a family of alarms.\nCannot be defined at the same time as alarmDedupeStringOverride.", "stability": "experimental", "summary": "If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 142 }, "name": "alarmDedupeStringSuffix", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- default auto-generated content only", "stability": "experimental", "summary": "A text included in the generated ticket description body, which fully replaces the generated text." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 102 }, "name": "alarmDescriptionOverride", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually.", "stability": "experimental", "summary": "If this is defined, the alarm name is set to this exact value." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 95 }, "name": "alarmNameOverride", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no parameters", "stability": "experimental", "summary": "This allows user to attach custom parameters to this alarm, which can later be accessed from the \"useCreatedAlarms\" method." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 247 }, "name": "customParams", "optional": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- no tags", "stability": "experimental", "summary": "This allows user to attach custom values to this alarm, which can later be accessed from the \"useCreatedAlarms\" method." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 240 }, "name": "customTags", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Number of breaches required to transition into an ALARM state." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 169 }, "name": "datapointsToAlarm", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- undefined (no override)", "remarks": "Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually.", "stability": "experimental", "summary": "If this is defined, the alarm dedupe string is set to this exact value." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 89 }, "name": "dedupeStringOverride", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- undefined (no disambiguator)", "stability": "experimental", "summary": "Disambiguator is a string that differentiates this alarm from other similar ones." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 109 }, "name": "disambiguator", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no additional link will be added", "stability": "experimental", "summary": "An optional link included in the generated ticket description body." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 121 }, "name": "documentationLink", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- true", "remarks": "If you specify false, the alarm state does not change during periods with too few data points to be statistically significant.\nIf you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available.", "stability": "experimental", "summary": "Used only for alarms based on percentiles." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 192 }, "name": "evaluateLowSampleCountPercentile", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- Same as datapointsToAlarm.", "stability": "experimental", "summary": "Number of periods to consider when checking the number of breaching datapoints." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 176 }, "name": "evaluationPeriods", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- false", "stability": "experimental", "summary": "Indicates whether the alarming range of values should be highlighted in the widget." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 254 }, "name": "fillAlarmRange", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no adjuster", "stability": "experimental", "summary": "If specified, adjusts the metric before creating an alarm from it." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 282 }, "name": "metricAdjuster", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.IMetricAdjuster" } }, { "abstract": true, "docs": { "default": "- default behaviour - no condition on sample count will be added to the alarm", "deprecated": "Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation\nperiod for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has\nsufficient number of samples", "remarks": "If this property is specified, an artificial composite alarm is created of the following:\n\nThe newly created composite alarm will be returned as a result, and it will take the original alarm actions.", "stability": "deprecated", "summary": "Specifies how many samples (N) of the metric is needed to trigger the alarm." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 233 }, "name": "minMetricSamplesToAlarm", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- default behaviour - no condition on sample count will be used", "remarks": "If this property is specified, your metric will be subject to MathExpression that will add an IF condition\nto your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples.\nIf the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated\naccording to the treatMissingData parameter.\nIf specified, deprecated minMetricSamplesToAlarm has no effect.", "stability": "experimental", "summary": "Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 204 }, "name": "minSampleCountToEvaluateDatapoint", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- no override (default color)", "stability": "experimental", "summary": "If specified, it modifies the final alarm annotation color." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 261 }, "name": "overrideAnnotationColor", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no override (default label)", "stability": "experimental", "summary": "If specified, it modifies the final alarm annotation label." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 268 }, "name": "overrideAnnotationLabel", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no override (default visibility)", "stability": "experimental", "summary": "If specified, it modifies the final alarm annotation visibility." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 275 }, "name": "overrideAnnotationVisibility", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- the default specified in MetricFactory", "stability": "experimental", "summary": "Period override for the metric to alarm on." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 183 }, "name": "period", "optional": true, "type": { "fqn": "aws-cdk-lib.Duration" } }, { "abstract": true, "docs": { "default": "- no additional link will be added", "stability": "experimental", "summary": "An optional link included in the generated ticket description body." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 128 }, "name": "runbookLink", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics\nproperty that should be used as the sampleCount metric for the new MathExpression as described in the documentation\nfor minSampleCountToEvaluateDatapoint.", "stability": "experimental", "summary": "This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 218 }, "name": "sampleCountMetricId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/common/alarm/AlarmFactory:AddAlarmProps" }, "cdk-monitoring-constructs.AddCompositeAlarmProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Properties necessary to create a composite alarm and configure it." }, "fqn": "cdk-monitoring-constructs.AddCompositeAlarmProps", "kind": "interface", "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 318 }, "name": "AddCompositeAlarmProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Disambiguator is a string that differentiates this alarm from other similar ones." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 350 }, "name": "disambiguator", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- default action will be used", "stability": "experimental", "summary": "Allows to override the default action strategy." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 324 }, "name": "actionOverride", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.IAlarmActionStrategy" } }, { "abstract": true, "docs": { "default": "- the same as monitoring facade default", "stability": "experimental", "summary": "Enables the configured CloudWatch alarm ticketing actions." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 394 }, "name": "actionsEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no suppressor alarm", "stability": "experimental", "summary": "Actions will be suppressed if the suppressor alarm is in the ALARM state." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 429 }, "name": "actionsSuppressor", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm" } }, { "abstract": true, "docs": { "default": "- 60 seconds", "remarks": "After this time, the composite alarm performs its actions.", "stability": "experimental", "summary": "The maximum duration that the composite alarm waits after suppressor alarm goes out of the ALARM state." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 437 }, "name": "actionsSuppressorExtensionPeriod", "optional": true, "type": { "fqn": "aws-cdk-lib.Duration" } }, { "abstract": true, "docs": { "default": "- 60 seconds", "remarks": "After this time, the composite alarm performs its actions.", "stability": "experimental", "summary": "The maximum duration that the composite alarm waits for the suppressor alarm to go into the ALARM state." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 445 }, "name": "actionsSuppressorWaitPeriod", "optional": true, "type": { "fqn": "aws-cdk-lib.Duration" } }, { "abstract": true, "docs": { "default": "- undefined (no suffix)", "remarks": "This allows you to specify the same dedupe string for a family of alarms.\nCannot be defined at the same time as dedupeStringOverride.", "stability": "experimental", "summary": "If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 387 }, "name": "alarmDedupeStringSuffix", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no description", "stability": "experimental", "summary": "Alarm description is included in the ticket and therefore should describe what happened, with as much context as possible." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 357 }, "name": "alarmDescription", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- default auto-generated content only", "stability": "experimental", "summary": "A text included in the generated ticket description body, which fully replaces the generated text." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 345 }, "name": "alarmDescriptionOverride", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually.", "stability": "experimental", "summary": "If this is defined, the alarm name is set to this exact value." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 338 }, "name": "alarmNameOverride", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no suffix", "remarks": "Alarm names need to be unique.", "stability": "experimental", "summary": "Suffix added to base alarm name." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 378 }, "name": "alarmNameSuffix", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- OR", "stability": "experimental", "summary": "Logical operator used to aggregate the status individual alarms." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 422 }, "name": "compositeOperator", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.CompositeAlarmOperator" } }, { "abstract": true, "docs": { "default": "- no parameters", "stability": "experimental", "summary": "This allows user to attach custom parameters to this alarm, which can later be accessed from the \"useCreatedAlarms\" method." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 408 }, "name": "customParams", "optional": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- no tags", "stability": "experimental", "summary": "This allows user to attach custom values to this alarm, which can later be accessed from the \"useCreatedAlarms\" method." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 401 }, "name": "customTags", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- undefined (no override)", "remarks": "Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually.", "stability": "experimental", "summary": "If this is defined, the alarm dedupe string is set to this exact value." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 332 }, "name": "dedupeStringOverride", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no additional link will be added", "stability": "experimental", "summary": "An optional link included in the generated ticket description body." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 364 }, "name": "documentationLink", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- false", "stability": "experimental", "summary": "Indicates whether the alarming range of values should be highlighted in the widget." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 415 }, "name": "fillAlarmRange", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no additional link will be added", "stability": "experimental", "summary": "An optional link included in the generated ticket description body." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 371 }, "name": "runbookLink", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/common/alarm/AlarmFactory:AddCompositeAlarmProps" }, "cdk-monitoring-constructs.AgeAlarmFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AgeAlarmFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/AgeAlarmFactory.ts", "line": 28 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/AgeAlarmFactory.ts", "line": 25 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/AgeAlarmFactory.ts", "line": 93 }, "name": "addDaysSinceUpdateAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.DaysSinceUpdateThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/AgeAlarmFactory.ts", "line": 32 }, "name": "addDaysToExpiryAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.DaysToExpiryThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/AgeAlarmFactory.ts", "line": 51 }, "name": "addIteratorMaxAgeAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MaxAgeThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/AgeAlarmFactory.ts", "line": 72 }, "name": "addMaxOffsetLagAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MaxOffsetLagThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } } ], "name": "AgeAlarmFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/AgeAlarmFactory.ts", "line": 26 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ], "symbolId": "lib/common/monitoring/alarms/AgeAlarmFactory:AgeAlarmFactory" }, "cdk-monitoring-constructs.AlarmActionStrategyProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Properties necessary to append actions to an alarm." }, "fqn": "cdk-monitoring-constructs.AlarmActionStrategyProps", "interfaces": [ "cdk-monitoring-constructs.AlarmMetadata" ], "kind": "interface", "locationInModule": { "filename": "lib/common/alarm/action/IAlarmActionStrategy.ts", "line": 8 }, "name": "AlarmActionStrategyProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/action/IAlarmActionStrategy.ts", "line": 9 }, "name": "alarm", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.AlarmBase" } } ], "symbolId": "lib/common/alarm/action/IAlarmActionStrategy:AlarmActionStrategyProps" }, "cdk-monitoring-constructs.AlarmAnnotationStrategyProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AlarmAnnotationStrategyProps", "interfaces": [ "cdk-monitoring-constructs.AlarmMetadata" ], "kind": "interface", "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 11 }, "name": "AlarmAnnotationStrategyProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 12 }, "name": "alarm", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Alarm" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 14 }, "name": "comparisonOperator", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.ComparisonOperator" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 18 }, "name": "datapointsToAlarm", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 19 }, "name": "evaluationPeriods", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 20 }, "name": "fillAlarmRange", "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 13 }, "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 17 }, "name": "threshold", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 15 }, "name": "minMetricSamplesToAlarm", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 16 }, "name": "minSampleCountToEvaluateDatapoint", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 21 }, "name": "overrideAnnotationColor", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 22 }, "name": "overrideAnnotationLabel", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 23 }, "name": "overrideAnnotationVisibility", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/common/alarm/IAlarmAnnotationStrategy:AlarmAnnotationStrategyProps" }, "cdk-monitoring-constructs.AlarmCloneFunction": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "remarks": "The function can be used to clone alarms.\n\nImplementers of this function can use the original alarm configuration to specify a new alarm,\nor they can return undefined to skip the creation of an alarm.", "stability": "experimental", "summary": "A function that, when given an alarm, returns modified inputs that can be used to create additional alarms, slightly adjusted from the original one." }, "fqn": "cdk-monitoring-constructs.AlarmCloneFunction", "kind": "interface", "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 148 }, "name": "AlarmCloneFunction", "symbolId": "lib/facade/MonitoringFacade:AlarmCloneFunction" }, "cdk-monitoring-constructs.AlarmCreateDefinition": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Describes the inputs to a single alarm's creation and configuration." }, "fqn": "cdk-monitoring-constructs.AlarmCreateDefinition", "kind": "interface", "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 288 }, "name": "AlarmCreateDefinition", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "The requested configuration for the alarm." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 297 }, "name": "addAlarmProps", "type": { "fqn": "cdk-monitoring-constructs.AddAlarmProps" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "The alarm factory that created the alarm." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 312 }, "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Number of breaches required to transition into an ALARM state." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 302 }, "name": "datapointsToAlarm", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Number of periods to consider when checking the number of breaching datapoints." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 307 }, "name": "evaluationPeriods", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "The original, unadjusted metric on which the alarm was created." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 292 }, "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } ], "symbolId": "lib/common/alarm/AlarmFactory:AlarmCreateDefinition" }, "cdk-monitoring-constructs.AlarmFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AlarmFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 570 }, "parameters": [ { "name": "alarmScope", "type": { "fqn": "constructs.Construct" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 564 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 583 }, "name": "addAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AddAlarmProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 824 }, "name": "addCompositeAlarm", "parameters": [ { "name": "alarms", "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" }, "kind": "array" } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AddCompositeAlarmProps" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.CompositeAlarm" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 959 }, "name": "createAnnotation", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmAnnotationStrategyProps" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 902 }, "name": "determineAction", "parameters": [ { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } }, { "name": "actionOverride", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.IAlarmActionStrategy" } } ], "protected": true, "returns": { "type": { "fqn": "cdk-monitoring-constructs.IAlarmActionStrategy" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 883 }, "name": "determineActionsEnabled", "parameters": [ { "name": "actionsEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "protected": true, "returns": { "type": { "primitive": "boolean" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 867 }, "name": "determineCompositeAlarmRule", "parameters": [ { "name": "alarms", "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" }, "kind": "array" } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AddCompositeAlarmProps" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmRule" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 931 }, "name": "generateDescription", "parameters": [ { "name": "alarmDescription", "type": { "primitive": "string" } }, { "name": "alarmDescriptionOverride", "optional": true, "type": { "primitive": "string" } }, { "name": "runbookLinkOverride", "optional": true, "type": { "primitive": "string" } }, { "name": "documentationLinkOverride", "optional": true, "type": { "primitive": "string" } } ], "protected": true, "returns": { "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 955 }, "name": "joinDescriptionParts", "parameters": [ { "name": "parts", "type": { "primitive": "string" }, "variadic": true } ], "protected": true, "returns": { "type": { "primitive": "string" } }, "variadic": true } ], "name": "AlarmFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 568 }, "name": "alarmNamingStrategy", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.IAlarmNamingStrategy" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 565 }, "name": "alarmScope", "protected": true, "type": { "fqn": "constructs.Construct" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 566 }, "name": "globalAlarmDefaults", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactoryDefaults" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 567 }, "name": "globalMetricDefaults", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactoryDefaults" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 923 }, "name": "shouldUseDefaultDedupeForError", "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 927 }, "name": "shouldUseDefaultDedupeForLatency", "type": { "primitive": "boolean" } } ], "symbolId": "lib/common/alarm/AlarmFactory:AlarmFactory" }, "cdk-monitoring-constructs.AlarmFactoryDefaults": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AlarmFactoryDefaults", "kind": "interface", "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 467 }, "name": "AlarmFactoryDefaults", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Enables the configured CloudWatch alarm ticketing actions for either all severities, or per severity." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 471 }, "name": "actionsEnabled", "type": { "union": { "types": [ { "primitive": "boolean" }, { "collection": { "elementtype": { "primitive": "boolean" }, "kind": "map" } } ] } } }, { "abstract": true, "docs": { "remarks": "This should be something unique to avoid potential collisions.\nThis is ignored if an alarm's dedupeStringOverride is declared.", "stability": "experimental", "summary": "Global prefix for all alarm names." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 529 }, "name": "alarmNamePrefix", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no action.", "stability": "experimental", "summary": "Default alarm action used for each alarm, unless it is overridden." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 478 }, "name": "action", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.IAlarmActionStrategy" } }, { "abstract": true, "docs": { "default": "- default behaviour (no change)", "stability": "experimental", "summary": "Custom strategy to name alarms." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 509 }, "name": "alarmNamingStrategy", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.IAlarmNamingStrategy" } }, { "abstract": true, "docs": { "default": "- default annotations", "stability": "experimental", "summary": "Custom strategy to create annotations for alarms." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 495 }, "name": "annotationStrategy", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.IAlarmAnnotationStrategy" } }, { "abstract": true, "docs": { "default": "- 3", "stability": "experimental", "summary": "Number of breaches required to transition into an ALARM state." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 516 }, "name": "datapointsToAlarm", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- default behaviour (no change)", "stability": "experimental", "summary": "Custom strategy to process dedupe strings of the alarms." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 502 }, "name": "dedupeStringProcessor", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.IAlarmDedupeStringProcessor" } }, { "abstract": true, "docs": { "default": "- Global alarm action if defined.", "stability": "experimental", "summary": "Optional alarm action for each disambiguator." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 485 }, "name": "disambiguatorAction", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.IAlarmActionStrategy" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An optional link included in the generated ticket description body." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 534 }, "name": "documentationLink", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Same as datapointsToAlarm.", "stability": "experimental", "summary": "Number of periods to consider when checking the number of breaching datapoints." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 523 }, "name": "evaluationPeriods", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An optional link included in the generated ticket description body." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 539 }, "name": "runbookLink", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- undefined (true)", "remarks": "This essentially stops the dedupe of different errors together.", "stability": "experimental", "summary": "If this is defined as false and dedupeStringOverride is undefined, the alarm prefix will be part of the dedupe string." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 547 }, "name": "useDefaultDedupeForError", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- undefined (true)", "remarks": "This essentially stops the dedupe of different latency issues together.", "stability": "experimental", "summary": "If this is defined as false and dedupeStringOverride is undefined, the alarm prefix will be part of the dedupe string." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 555 }, "name": "useDefaultDedupeForLatency", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/common/alarm/AlarmFactory:AlarmFactoryDefaults" }, "cdk-monitoring-constructs.AlarmFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AlarmFactoryProps", "kind": "interface", "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 558 }, "name": "AlarmFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 559 }, "name": "globalAlarmDefaults", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactoryDefaults" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 560 }, "name": "globalMetricDefaults", "type": { "fqn": "cdk-monitoring-constructs.MetricFactoryDefaults" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 561 }, "name": "localAlarmNamePrefix", "type": { "primitive": "string" } } ], "symbolId": "lib/common/alarm/AlarmFactory:AlarmFactoryProps" }, "cdk-monitoring-constructs.AlarmMatrixWidget": { "assembly": "cdk-monitoring-constructs", "base": "aws-cdk-lib.aws_cloudwatch.AlarmStatusWidget", "docs": { "remarks": "Always takes the maximum width.", "stability": "experimental", "summary": "Wrapper of Alarm Status Widget which auto-calcultes height based on the number of alarms." }, "fqn": "cdk-monitoring-constructs.AlarmMatrixWidget", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/widget/AlarmMatrixWidget.ts", "line": 31 }, "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmMatrixWidgetProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/dashboard/widget/AlarmMatrixWidget.ts", "line": 30 }, "name": "AlarmMatrixWidget", "symbolId": "lib/dashboard/widget/AlarmMatrixWidget:AlarmMatrixWidget" }, "cdk-monitoring-constructs.AlarmMatrixWidgetProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AlarmMatrixWidgetProps", "kind": "interface", "locationInModule": { "filename": "lib/dashboard/widget/AlarmMatrixWidget.ts", "line": 9 }, "name": "AlarmMatrixWidgetProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "list of alarms to show." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/AlarmMatrixWidget.ts", "line": 23 }, "name": "alarms", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- auto calculated based on alarm number (3 to 8)", "stability": "experimental", "summary": "desired height." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/AlarmMatrixWidget.ts", "line": 19 }, "name": "height", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- no title", "stability": "experimental", "summary": "widget title." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/AlarmMatrixWidget.ts", "line": 14 }, "name": "title", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/dashboard/widget/AlarmMatrixWidget:AlarmMatrixWidgetProps" }, "cdk-monitoring-constructs.AlarmMetadata": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Metadata of an alarm." }, "fqn": "cdk-monitoring-constructs.AlarmMetadata", "kind": "interface", "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 48 }, "name": "AlarmMetadata", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 49 }, "name": "action", "type": { "fqn": "cdk-monitoring-constructs.IAlarmActionStrategy" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 53 }, "name": "customParams", "optional": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 52 }, "name": "customTags", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 50 }, "name": "dedupeString", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 51 }, "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/common/alarm/AlarmFactory:AlarmMetadata" }, "cdk-monitoring-constructs.AlarmNamingInput": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AlarmNamingInput", "kind": "interface", "locationInModule": { "filename": "lib/common/alarm/IAlarmNamingStrategy.ts", "line": 3 }, "name": "AlarmNamingInput", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmNamingStrategy.ts", "line": 6 }, "name": "alarmNameSuffix", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmNamingStrategy.ts", "line": 5 }, "name": "action", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.IAlarmActionStrategy" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmNamingStrategy.ts", "line": 8 }, "name": "alarmDedupeStringSuffix", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmNamingStrategy.ts", "line": 7 }, "name": "alarmNameOverride", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmNamingStrategy.ts", "line": 9 }, "name": "dedupeStringOverride", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmNamingStrategy.ts", "line": 10 }, "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/common/alarm/IAlarmNamingStrategy:AlarmNamingInput" }, "cdk-monitoring-constructs.AlarmNamingStrategy": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AlarmNamingStrategy", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/AlarmNamingStrategy.ts", "line": 15 }, "parameters": [ { "name": "globalPrefix", "type": { "primitive": "string" } }, { "name": "localPrefix", "type": { "primitive": "string" } }, { "name": "dedupeStringStrategy", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.IAlarmDedupeStringProcessor" } } ] }, "interfaces": [ "cdk-monitoring-constructs.IAlarmNamingStrategy" ], "kind": "class", "locationInModule": { "filename": "lib/common/alarm/AlarmNamingStrategy.ts", "line": 10 }, "methods": [ { "docs": { "remarks": "- If \"alarmDedupeStringSuffix\" from the alarm factory is defined, \"GlobalPrefix-LocalPrefix-AlarmDedupeStringSuffix\" will be used as a dedupe string.\n- Otherwise, the alarm dedupe string will not be set.\nIf a dedupe string strategy is set, it will be used to process the final string.", "stability": "experimental", "summary": "Dedupe string resolved like this: - If \"dedupeStringOverride\" is defined for an alarm, it will be used as a dedupe string." }, "locationInModule": { "filename": "lib/common/alarm/AlarmNamingStrategy.ts", "line": 71 }, "name": "getDedupeString", "overrides": "cdk-monitoring-constructs.IAlarmNamingStrategy", "parameters": [ { "docs": { "summary": "properties." }, "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmNamingInput" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "remarks": "- Otherwise, the alarm name will be generated by joining: global prefix, local prefix, alarm name suffix, disambiguator.", "stability": "experimental", "summary": "Alarm name is resolved like this: - If \"alarmNameOverride\" is defined for an alarm, it will be used as alarm name." }, "locationInModule": { "filename": "lib/common/alarm/AlarmNamingStrategy.ts", "line": 33 }, "name": "getName", "overrides": "cdk-monitoring-constructs.IAlarmNamingStrategy", "parameters": [ { "docs": { "summary": "properties." }, "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmNamingInput" } } ], "returns": { "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental", "summary": "How to generate the label for the alarm displayed on a widget." }, "locationInModule": { "filename": "lib/common/alarm/AlarmNamingStrategy.ts", "line": 51 }, "name": "getWidgetLabel", "overrides": "cdk-monitoring-constructs.IAlarmNamingStrategy", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmNamingInput" } } ], "returns": { "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/AlarmNamingStrategy.ts", "line": 92 }, "name": "joinDistinct", "parameters": [ { "name": "parts", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "name": "separator", "type": { "primitive": "string" } } ], "protected": true, "returns": { "type": { "primitive": "string" } } } ], "name": "AlarmNamingStrategy", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmNamingStrategy.ts", "line": 13 }, "name": "dedupeStringStrategy", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.IAlarmDedupeStringProcessor" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmNamingStrategy.ts", "line": 11 }, "name": "globalPrefix", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmNamingStrategy.ts", "line": 12 }, "name": "localPrefix", "protected": true, "type": { "primitive": "string" } } ], "symbolId": "lib/common/alarm/AlarmNamingStrategy:AlarmNamingStrategy" }, "cdk-monitoring-constructs.AlarmSummaryMatrixWidget": { "assembly": "cdk-monitoring-constructs", "base": "aws-cdk-lib.aws_cloudwatch.ConcreteWidget", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AlarmSummaryMatrixWidget", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/widget/UnofficialWidgets.ts", "line": 17 }, "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmSummaryMatrixWidgetProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/dashboard/widget/UnofficialWidgets.ts", "line": 14 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Return the widget JSON for use in the dashboard." }, "locationInModule": { "filename": "lib/dashboard/widget/UnofficialWidgets.ts", "line": 22 }, "name": "toJson", "overrides": "aws-cdk-lib.aws_cloudwatch.ConcreteWidget", "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "array" } } } } ], "name": "AlarmSummaryMatrixWidget", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/UnofficialWidgets.ts", "line": 15 }, "name": "props", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmSummaryMatrixWidgetProps" } } ], "symbolId": "lib/dashboard/widget/UnofficialWidgets:AlarmSummaryMatrixWidget" }, "cdk-monitoring-constructs.AlarmSummaryMatrixWidgetPropertiesJson": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AlarmSummaryMatrixWidgetPropertiesJson", "kind": "interface", "locationInModule": { "filename": "lib/dashboard/widget/UnofficialWidgets.ts", "line": 9 }, "name": "AlarmSummaryMatrixWidgetPropertiesJson", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/UnofficialWidgets.ts", "line": 11 }, "name": "alarms", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/UnofficialWidgets.ts", "line": 10 }, "name": "title", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/dashboard/widget/UnofficialWidgets:AlarmSummaryMatrixWidgetPropertiesJson" }, "cdk-monitoring-constructs.AlarmSummaryMatrixWidgetProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AlarmSummaryMatrixWidgetProps", "interfaces": [ "aws-cdk-lib.aws_cloudwatch.MetricWidgetProps" ], "kind": "interface", "locationInModule": { "filename": "lib/dashboard/widget/UnofficialWidgets.ts", "line": 5 }, "name": "AlarmSummaryMatrixWidgetProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/UnofficialWidgets.ts", "line": 6 }, "name": "alarmArns", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/dashboard/widget/UnofficialWidgets:AlarmSummaryMatrixWidgetProps" }, "cdk-monitoring-constructs.AlarmWithAnnotation": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Representation of an alarm with additional information." }, "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation", "interfaces": [ "cdk-monitoring-constructs.AlarmMetadata" ], "kind": "interface", "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 59 }, "name": "AlarmWithAnnotation", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 60 }, "name": "alarm", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.AlarmBase" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 65 }, "name": "alarmDefinition", "type": { "fqn": "cdk-monitoring-constructs.AlarmCreateDefinition" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 64 }, "name": "alarmDescription", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 63 }, "name": "alarmLabel", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 61 }, "name": "alarmName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 62 }, "name": "alarmNameSuffix", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 67 }, "name": "alarmRuleWhenAlarming", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmRule" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 68 }, "name": "alarmRuleWhenInsufficientData", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmRule" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 66 }, "name": "alarmRuleWhenOk", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmRule" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 69 }, "name": "annotation", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" } } ], "symbolId": "lib/common/alarm/AlarmFactory:AlarmWithAnnotation" }, "cdk-monitoring-constructs.AnomalyDetectingAlarmFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AnomalyDetectingAlarmFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/AnomalyDetectingAlarmFactory.ts", "line": 19 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/AnomalyDetectingAlarmFactory.ts", "line": 16 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/AnomalyDetectingAlarmFactory.ts", "line": 23 }, "name": "addAlarmWhenOutOfBand", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "alarmNameSuffix", "type": { "primitive": "string" } }, { "name": "disambiguator", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AnomalyDetectionThreshold" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } } ], "name": "AnomalyDetectingAlarmFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/AnomalyDetectingAlarmFactory.ts", "line": 17 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ], "symbolId": "lib/common/monitoring/alarms/AnomalyDetectingAlarmFactory:AnomalyDetectingAlarmFactory" }, "cdk-monitoring-constructs.AnomalyDetectionMathExpression": { "assembly": "cdk-monitoring-constructs", "base": "aws-cdk-lib.aws_cloudwatch.MathExpression", "docs": { "remarks": "Added to overcome certain CDK limitations at the time of writing.", "see": "https://github.com/aws/aws-cdk/issues/10540", "stability": "experimental", "summary": "Captures specific MathExpression for anomaly detection, for which alarm generation is different." }, "fqn": "cdk-monitoring-constructs.AnomalyDetectionMathExpression", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/metric/AnomalyDetectionMathExpression.ts", "line": 17 }, "parameters": [ { "name": "props", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpressionProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/metric/AnomalyDetectionMathExpression.ts", "line": 16 }, "methods": [ { "docs": { "remarks": "Combines both properties that may adjust the metric (aggregation) as well\nas alarm properties.", "stability": "experimental", "summary": "Make a new Alarm for this metric." }, "locationInModule": { "filename": "lib/common/metric/AnomalyDetectionMathExpression.ts", "line": 31 }, "name": "createAlarm", "overrides": "aws-cdk-lib.aws_cloudwatch.MathExpression", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.CreateAlarmOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Alarm" } } }, { "docs": { "remarks": "All properties except namespace and metricName can be changed.", "stability": "experimental", "summary": "Return a copy of Metric with properties changed." }, "locationInModule": { "filename": "lib/common/metric/AnomalyDetectionMathExpression.ts", "line": 21 }, "name": "with", "overrides": "aws-cdk-lib.aws_cloudwatch.MathExpression", "parameters": [ { "name": "props", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpressionOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } } } ], "name": "AnomalyDetectionMathExpression", "symbolId": "lib/common/metric/AnomalyDetectionMathExpression:AnomalyDetectionMathExpression" }, "cdk-monitoring-constructs.AnomalyDetectionThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AnomalyDetectionThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/AnomalyDetectingAlarmFactory.ts", "line": 9 }, "name": "AnomalyDetectionThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/AnomalyDetectingAlarmFactory.ts", "line": 11 }, "name": "alarmWhenAboveTheBand", "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/AnomalyDetectingAlarmFactory.ts", "line": 12 }, "name": "alarmWhenBelowTheBand", "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/AnomalyDetectingAlarmFactory.ts", "line": 10 }, "name": "standardDeviationForAlarm", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/AnomalyDetectingAlarmFactory.ts", "line": 13 }, "name": "additionalDescription", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/common/monitoring/alarms/AnomalyDetectingAlarmFactory:AnomalyDetectionThreshold" }, "cdk-monitoring-constructs.ApiGatewayAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ApiGatewayAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 49 }, "name": "ApiGatewayAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 50 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.ApiGatewayMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:ApiGatewayAspectType" }, "cdk-monitoring-constructs.ApiGatewayMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ApiGatewayMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 49 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.ApiGatewayMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 44 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 97 }, "name": "metric4XXErrorCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 111 }, "name": "metric4XXErrorRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 120 }, "name": "metric5XXFaultCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 134 }, "name": "metric5XXFaultRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 83 }, "name": "metricInvocationCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 73 }, "name": "metricInvocationRate", "parameters": [ { "name": "rateComputationMethod", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 164 }, "name": "metricLatencyInMillis", "parameters": [ { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "deprecated": "Use {@link metricLatencyInMillis } instead.", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 160 }, "name": "metricLatencyP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "deprecated": "Use {@link metricLatencyInMillis } instead.", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 153 }, "name": "metricLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "deprecated": "Use {@link metricLatencyInMillis } instead.", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 146 }, "name": "metricLatencyP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "deprecated": "use metricInvocationRate", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 69 }, "name": "metricTps", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "ApiGatewayMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 47 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 45 }, "name": "fillTpsWithZeroes", "protected": true, "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 46 }, "name": "rateComputationMethod", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory:ApiGatewayMetricFactory" }, "cdk-monitoring-constructs.ApiGatewayMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ApiGatewayMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 17 }, "name": "ApiGatewayMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "API to monitor." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 21 }, "name": "api", "type": { "fqn": "aws-cdk-lib.aws_apigateway.IRestApi" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "On undefined value is not set in dimensions." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 29 }, "name": "apiMethod", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "On undefined value is not set in dimensions." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 33 }, "name": "apiResource", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- prod", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 25 }, "name": "apiStage", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- true", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 37 }, "name": "fillTpsWithZeroes", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- average", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 41 }, "name": "rateComputationMethod", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory:ApiGatewayMetricFactoryProps" }, "cdk-monitoring-constructs.ApiGatewayMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ApiGatewayMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 114 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.ApiGatewayMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 91 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 337 }, "name": "createErrorCountWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 348 }, "name": "createErrorRateWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 322 }, "name": "createLatencyWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 304 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 311 }, "name": "createTpsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 285 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 294 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "ApiGatewayMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 94 }, "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 105 }, "name": "error4XXCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 106 }, "name": "error4XXRateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 95 }, "name": "errorAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 101 }, "name": "errorCountAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 102 }, "name": "errorRateAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 107 }, "name": "fault5XXCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 108 }, "name": "fault5XXRateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 97 }, "name": "latencyAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 100 }, "name": "latencyAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 111 }, "name": "latencyMetrics", "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 112 }, "name": "latencyTypesToRender", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 92 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 96 }, "name": "tpsAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.TpsAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 99 }, "name": "tpsAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 104 }, "name": "tpsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } ], "symbolId": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring:ApiGatewayMonitoring" }, "cdk-monitoring-constructs.ApiGatewayMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ApiGatewayMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 47 }, "name": "ApiGatewayMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 48 }, "name": "add4XXErrorCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 49 }, "name": "add4XXErrorRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 50 }, "name": "add5XXFaultCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 51 }, "name": "add5XXFaultRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 75 }, "name": "addHighTpsAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.HighTpsThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 72 }, "name": "addLatencyAverageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 60 }, "name": "addLatencyP100Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 53 }, "name": "addLatencyP50Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 54 }, "name": "addLatencyP70Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 55 }, "name": "addLatencyP90Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 56 }, "name": "addLatencyP95Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 59 }, "name": "addLatencyP9999Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 58 }, "name": "addLatencyP999Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 57 }, "name": "addLatencyP99Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 61 }, "name": "addLatencyTM50Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 62 }, "name": "addLatencyTM70Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 63 }, "name": "addLatencyTM90Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 64 }, "name": "addLatencyTM95Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 68 }, "name": "addLatencyTM95OutlierAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 67 }, "name": "addLatencyTM9999Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 71 }, "name": "addLatencyTM9999OutlierAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 66 }, "name": "addLatencyTM999Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 70 }, "name": "addLatencyTM999OutlierAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 65 }, "name": "addLatencyTM99Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 69 }, "name": "addLatencyTM99OutlierAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 74 }, "name": "addLowTpsAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LowTpsThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- p50, p90, p99 (@see DefaultLatencyTypesToRender)", "remarks": "Note: any latency type with an alarm will be also added automatically.\nIf the list is undefined, default values will be shown.\nIf the list is empty, only the latency types with an alarm will be shown (if any).", "stability": "experimental", "summary": "You can specify what latency types you want to be rendered in the dashboards." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 84 }, "name": "latencyTypesToRender", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyType" }, "kind": "array" } } } ], "symbolId": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring:ApiGatewayMonitoringOptions" }, "cdk-monitoring-constructs.ApiGatewayMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ApiGatewayMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.ApiGatewayMetricFactoryProps", "cdk-monitoring-constructs.ApiGatewayMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 87 }, "name": "ApiGatewayMonitoringProps", "symbolId": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring:ApiGatewayMonitoringProps" }, "cdk-monitoring-constructs.ApiGatewayV2AspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ApiGatewayV2AspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 53 }, "name": "ApiGatewayV2AspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 54 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.ApiGatewayV2MonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:ApiGatewayV2AspectType" }, "cdk-monitoring-constructs.ApiGatewayV2HttpApiMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ApiGatewayV2HttpApiMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 47 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.ApiGatewayV2HttpApiMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 42 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 91 }, "name": "metric4xxCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 105 }, "name": "metric4xxRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 114 }, "name": "metric5xxCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 128 }, "name": "metric5xxRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 179 }, "name": "metricIntegrationLatencyInMillis", "parameters": [ { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "deprecated": "Use {@link metricIntegrationLatencyInMillis } instead.", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 161 }, "name": "metricIntegrationLatencyP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "deprecated": "Use {@link metricIntegrationLatencyInMillis } instead.", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 168 }, "name": "metricIntegrationLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "deprecated": "Use {@link metricIntegrationLatencyInMillis } instead.", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 175 }, "name": "metricIntegrationLatencyP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 80 }, "name": "metricInvocationCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 71 }, "name": "metricInvocationRate", "parameters": [ { "name": "rateComputationMethod", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 194 }, "name": "metricLatencyInMillis", "parameters": [ { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "deprecated": "Use {@link metricLatencyInMillis } instead.", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 140 }, "name": "metricLatencyP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "deprecated": "Use {@link metricLatencyInMillis } instead.", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 147 }, "name": "metricLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "deprecated": "Use {@link metricLatencyInMillis } instead.", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 154 }, "name": "metricLatencyP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "deprecated": "use metricInvocationRate", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 67 }, "name": "metricTps", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "ApiGatewayV2HttpApiMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 45 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 43 }, "name": "fillTpsWithZeroes", "protected": true, "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 44 }, "name": "rateComputationMethod", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory:ApiGatewayV2HttpApiMetricFactory" }, "cdk-monitoring-constructs.ApiGatewayV2HttpApiMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ApiGatewayV2HttpApiMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 17 }, "name": "ApiGatewayV2HttpApiMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 19 }, "name": "api", "type": { "fqn": "aws-cdk-lib.aws_apigatewayv2.IHttpApi" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "On undefined value is not set in dimensions." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 27 }, "name": "apiMethod", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "On undefined value is not set in dimensions." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 31 }, "name": "apiResource", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- $default", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 23 }, "name": "apiStage", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- true", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 35 }, "name": "fillTpsWithZeroes", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- average", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 39 }, "name": "rateComputationMethod", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory:ApiGatewayV2HttpApiMetricFactoryProps" }, "cdk-monitoring-constructs.ApiGatewayV2HttpApiMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ApiGatewayV2HttpApiMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 155 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.ApiGatewayV2HttpApiMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 131 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 438 }, "name": "createErrorCountWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 449 }, "name": "createErrorRateWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 418 }, "name": "createLatencyWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 400 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 407 }, "name": "createTpsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 381 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 390 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "ApiGatewayV2HttpApiMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 134 }, "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 145 }, "name": "error4xxCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 146 }, "name": "error4xxRateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 147 }, "name": "error5xxCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 148 }, "name": "error5xxRateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 135 }, "name": "errorAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 141 }, "name": "errorCountAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 142 }, "name": "errorRateAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 152 }, "name": "integrationLatencyMetrics", "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 137 }, "name": "latencyAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 140 }, "name": "latencyAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 151 }, "name": "latencyMetrics", "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 153 }, "name": "latencyTypesToRender", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 132 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 136 }, "name": "tpsAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.TpsAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 139 }, "name": "tpsAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 144 }, "name": "tpsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } ], "symbolId": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring:ApiGatewayV2HttpApiMonitoring" }, "cdk-monitoring-constructs.ApiGatewayV2HttpApiMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ApiGatewayV2HttpApiMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.ApiGatewayV2HttpApiMetricFactoryProps", "cdk-monitoring-constructs.ApiGatewayV2MonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 127 }, "name": "ApiGatewayV2HttpApiMonitoringProps", "symbolId": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring:ApiGatewayV2HttpApiMonitoringProps" }, "cdk-monitoring-constructs.ApiGatewayV2MonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ApiGatewayV2MonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 48 }, "name": "ApiGatewayV2MonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 49 }, "name": "add4xxCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 50 }, "name": "add4xxRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 51 }, "name": "add5xxCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 52 }, "name": "add5xxRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 115 }, "name": "addHighTpsAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.HighTpsThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 112 }, "name": "addIntegrationLatencyAverageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 85 }, "name": "addIntegrationLatencyP100Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 78 }, "name": "addIntegrationLatencyP50Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 79 }, "name": "addIntegrationLatencyP70Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 80 }, "name": "addIntegrationLatencyP90Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 81 }, "name": "addIntegrationLatencyP95Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 84 }, "name": "addIntegrationLatencyP9999Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 83 }, "name": "addIntegrationLatencyP999Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 82 }, "name": "addIntegrationLatencyP99Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 87 }, "name": "addIntegrationLatencyTM50Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 88 }, "name": "addIntegrationLatencyTM70Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 89 }, "name": "addIntegrationLatencyTM90Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 90 }, "name": "addIntegrationLatencyTM95Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 95 }, "name": "addIntegrationLatencyTM95OutlierAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 93 }, "name": "addIntegrationLatencyTM9999Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 107 }, "name": "addIntegrationLatencyTM9999OutlierAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 92 }, "name": "addIntegrationLatencyTM999Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 103 }, "name": "addIntegrationLatencyTM999OutlierAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 91 }, "name": "addIntegrationLatencyTM99Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 99 }, "name": "addIntegrationLatencyTM99OutlierAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 76 }, "name": "addLatencyAverageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 61 }, "name": "addLatencyP100Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 54 }, "name": "addLatencyP50Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 55 }, "name": "addLatencyP70Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 56 }, "name": "addLatencyP90Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 57 }, "name": "addLatencyP95Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 60 }, "name": "addLatencyP9999Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 59 }, "name": "addLatencyP999Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 58 }, "name": "addLatencyP99Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 63 }, "name": "addLatencyTM50Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 64 }, "name": "addLatencyTM70Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 65 }, "name": "addLatencyTM90Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 66 }, "name": "addLatencyTM95Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 71 }, "name": "addLatencyTM95OutlierAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 69 }, "name": "addLatencyTM9999Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 74 }, "name": "addLatencyTM9999OutlierAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 68 }, "name": "addLatencyTM999Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 73 }, "name": "addLatencyTM999OutlierAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 67 }, "name": "addLatencyTM99Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 72 }, "name": "addLatencyTM99OutlierAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 114 }, "name": "addLowTpsAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LowTpsThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- p50, p90, p99 (@see DefaultLatencyTypesShown)", "remarks": "Note: any latency type with an alarm will be also added automatically.\nIf the list is undefined, default values will be shown.\nIf the list is empty, only the latency types with an alarm will be shown (if any).", "stability": "experimental", "summary": "You can specify what latency types you want to be rendered in the dashboards." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 124 }, "name": "latencyTypesToRender", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyType" }, "kind": "array" } } } ], "symbolId": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring:ApiGatewayV2MonitoringOptions" }, "cdk-monitoring-constructs.AppSyncAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AppSyncAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 57 }, "name": "AppSyncAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 58 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.AppSyncMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:AppSyncAspectType" }, "cdk-monitoring-constructs.AppSyncMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AppSyncMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 36 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AppSyncMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 31 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 120 }, "name": "metric4XXErrorCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 134 }, "name": "metric4XXErrorRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 143 }, "name": "metric5XXFaultCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 157 }, "name": "metric5XXFaultRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 78 }, "name": "metricLatencyP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 92 }, "name": "metricLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 106 }, "name": "metricLatencyP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 64 }, "name": "metricRequestCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 54 }, "name": "metricRequestRate", "parameters": [ { "name": "rateComputationMethod", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "deprecated": "use metricRequestRate", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 50 }, "name": "metricTps", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "AppSyncMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 34 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 32 }, "name": "fillTpsWithZeroes", "protected": true, "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 33 }, "name": "rateComputationMethod", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-appsync/AppSyncMetricFactory:AppSyncMetricFactory" }, "cdk-monitoring-constructs.AppSyncMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AppSyncMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 14 }, "name": "AppSyncMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "the GraphQL API to monitor." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 18 }, "name": "api", "type": { "fqn": "aws-cdk-lib.aws_appsync.IGraphqlApi" } }, { "abstract": true, "docs": { "default": "- true", "stability": "experimental", "summary": "whether the TPS should be filled with zeroes." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 23 }, "name": "fillTpsWithZeroes", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- average", "stability": "experimental", "summary": "method to compute TPS." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 28 }, "name": "rateComputationMethod", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-appsync/AppSyncMetricFactory:AppSyncMetricFactoryProps" }, "cdk-monitoring-constructs.AppSyncMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AppSyncMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 83 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AppSyncMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 59 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 276 }, "name": "createErrorCountWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 287 }, "name": "createErrorRateWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 261 }, "name": "createLatencyWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 250 }, "name": "createTpsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 243 }, "name": "createtTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 224 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 233 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "AppSyncMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 64 }, "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 80 }, "name": "error4xxCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 81 }, "name": "error4xxRateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 65 }, "name": "errorAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 71 }, "name": "errorCountAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 72 }, "name": "errorRateAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 78 }, "name": "fault5xxCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 79 }, "name": "fault5xxRateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 66 }, "name": "latencyAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 70 }, "name": "latencyAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 63 }, "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.AppSyncMetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 62 }, "name": "namingStrategy", "type": { "fqn": "cdk-monitoring-constructs.MonitoringNamingStrategy" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 75 }, "name": "p50LatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 76 }, "name": "p90LatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 77 }, "name": "p99LatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 60 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 67 }, "name": "tpsAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.TpsAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 69 }, "name": "tpsAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 74 }, "name": "tpsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } ], "symbolId": "lib/monitoring/aws-appsync/AppSyncMonitoring:AppSyncMonitoring" }, "cdk-monitoring-constructs.AppSyncMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AppSyncMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 41 }, "name": "AppSyncMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 42 }, "name": "add4XXErrorCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 43 }, "name": "add4XXErrorRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 44 }, "name": "add5XXFaultCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 45 }, "name": "add5XXFaultRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 52 }, "name": "addHighTpsAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.HighTpsThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 47 }, "name": "addLatencyP50Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 48 }, "name": "addLatencyP90Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 49 }, "name": "addLatencyP99Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 51 }, "name": "addLowTpsAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LowTpsThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-appsync/AppSyncMonitoring:AppSyncMonitoringOptions" }, "cdk-monitoring-constructs.AppSyncMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AppSyncMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.AppSyncMonitoringOptions", "cdk-monitoring-constructs.AppSyncMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 55 }, "name": "AppSyncMonitoringProps", "symbolId": "lib/monitoring/aws-appsync/AppSyncMonitoring:AppSyncMonitoringProps" }, "cdk-monitoring-constructs.ApplicationLoadBalancerMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental", "summary": "Metric factory to create metrics for application load-balanced service." }, "fqn": "cdk-monitoring-constructs.ApplicationLoadBalancerMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 40 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.ApplicationLoadBalancerMetricFactoryProps" } } ] }, "interfaces": [ "cdk-monitoring-constructs.ILoadBalancerMetricFactory" ], "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 32 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 91 }, "name": "metricActiveConnectionCount", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 52 }, "name": "metricHealthyTaskCount", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 80 }, "name": "metricHealthyTaskInPercent", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 101 }, "name": "metricNewConnectionCount", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 111 }, "name": "metricProcessedBytesMin", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 122 }, "name": "metricUnhealthyRoutingCount", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 66 }, "name": "metricUnhealthyTaskCount", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "ApplicationLoadBalancerMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 36 }, "name": "applicationLoadBalancer", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 37 }, "name": "applicationTargetGroup", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationTargetGroup" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 38 }, "name": "invertStatisticsOfTaskCountEnabled", "protected": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory:ApplicationLoadBalancerMetricFactory" }, "cdk-monitoring-constructs.ApplicationLoadBalancerMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Props to create ApplicationLoadBalancerMetricFactory." }, "fqn": "cdk-monitoring-constructs.ApplicationLoadBalancerMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseLoadBalancerMetricFactoryProps", "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 22 }, "name": "ApplicationLoadBalancerMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 25 }, "name": "applicationLoadBalancer", "type": { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 26 }, "name": "applicationTargetGroup", "type": { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationTargetGroup" } } ], "symbolId": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory:ApplicationLoadBalancerMetricFactoryProps" }, "cdk-monitoring-constructs.AuroraAlarmFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AuroraAlarmFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/AuroraAlarmFactory.ts", "line": 17 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/AuroraAlarmFactory.ts", "line": 14 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/AuroraAlarmFactory.ts", "line": 21 }, "name": "addMaxServerlessDatabaseCapacity", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.HighServerlessDatabaseCapacityThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } } ], "name": "AuroraAlarmFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/AuroraAlarmFactory.ts", "line": 15 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ], "symbolId": "lib/common/monitoring/alarms/AuroraAlarmFactory:AuroraAlarmFactory" }, "cdk-monitoring-constructs.AuroraClusterAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AuroraClusterAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 61 }, "name": "AuroraClusterAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 62 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.AuroraClusterMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:AuroraClusterAspectType" }, "cdk-monitoring-constructs.AuroraClusterMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AuroraClusterMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 74 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AuroraClusterMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 54 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 205 }, "name": "createConnectionsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 194 }, "name": "createCpuUsageWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 216 }, "name": "createLatencyWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 232 }, "name": "createServerlessDatabaseCapacityWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 186 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 160 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 173 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "AuroraClusterMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 72 }, "name": "commitLatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 59 }, "name": "connectionAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.ConnectionAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 62 }, "name": "connectionAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 65 }, "name": "connectionsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 67 }, "name": "cpuUsageMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 71 }, "name": "deleteLatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 69 }, "name": "insertLatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 68 }, "name": "selectLatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 63 }, "name": "serverlessCapacityAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 66 }, "name": "serverlessDatabaseCapacityMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 55 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 70 }, "name": "updateLatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 58 }, "name": "usageAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.UsageAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 61 }, "name": "usageAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 56 }, "name": "url", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-rds/AuroraClusterMonitoring:AuroraClusterMonitoring" }, "cdk-monitoring-constructs.AuroraClusterMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AuroraClusterMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 34 }, "name": "AuroraClusterMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 39 }, "name": "addCpuUsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 44 }, "name": "addMaxConnectionCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.HighConnectionCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 35 }, "name": "addMaxServerlessDatabaseCapacityAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 40 }, "name": "addMinConnectionCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LowConnectionCountThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-rds/AuroraClusterMonitoring:AuroraClusterMonitoringOptions" }, "cdk-monitoring-constructs.AuroraClusterMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AuroraClusterMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.RdsClusterMetricFactoryProps", "cdk-monitoring-constructs.AuroraClusterMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-rds/AuroraClusterMonitoring.ts", "line": 50 }, "name": "AuroraClusterMonitoringProps", "symbolId": "lib/monitoring/aws-rds/AuroraClusterMonitoring:AuroraClusterMonitoringProps" }, "cdk-monitoring-constructs.AutoScalingGroupAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AutoScalingGroupAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 65 }, "name": "AutoScalingGroupAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 66 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.AutoScalingGroupMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:AutoScalingGroupAspectType" }, "cdk-monitoring-constructs.AutoScalingGroupMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AutoScalingGroupMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMetricFactory.ts", "line": 21 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AutoScalingGroupMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMetricFactory.ts", "line": 18 }, "methods": [ { "docs": { "stability": "experimental", "summary": "The number of instances that the Auto Scaling group attempts to maintain." }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMetricFactory.ts", "line": 49 }, "name": "metricGroupDesiredCapacity", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "remarks": "This metric does not include instances that are pending or terminating.", "stability": "experimental", "summary": "The number of instances that are running as part of the Auto Scaling group." }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMetricFactory.ts", "line": 62 }, "name": "metricGroupInServiceInstances", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental", "summary": "The maximum size of the Auto Scaling group." }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMetricFactory.ts", "line": 42 }, "name": "metricGroupMaxSize", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental", "summary": "The minimum size of the Auto Scaling group." }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMetricFactory.ts", "line": 35 }, "name": "metricGroupMinSize", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "remarks": "A pending instance is not yet in service.\nThis metric does not include instances that are in service or terminating.", "stability": "experimental", "summary": "The number of instances that are pending." }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMetricFactory.ts", "line": 74 }, "name": "metricGroupPendingInstances", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "remarks": "Instances in this state are still running but are not actively in service.", "stability": "experimental", "summary": "The number of instances that are in a Standby state." }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMetricFactory.ts", "line": 86 }, "name": "metricGroupStandbyInstances", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "remarks": "This metric does not include instances that are in service or pending.", "stability": "experimental", "summary": "The number of instances that are in the process of terminating." }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMetricFactory.ts", "line": 98 }, "name": "metricGroupTerminatingInstances", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "remarks": "This metric identifies the number of instances that are in service, pending, and terminating.", "stability": "experimental", "summary": "The total number of instances in the Auto Scaling group." }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMetricFactory.ts", "line": 110 }, "name": "metricGroupTotalInstances", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "AutoScalingGroupMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMetricFactory.ts", "line": 19 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-ec2/AutoScalingGroupMetricFactory:AutoScalingGroupMetricFactory" }, "cdk-monitoring-constructs.AutoScalingGroupMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AutoScalingGroupMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMetricFactory.ts", "line": 13 }, "name": "AutoScalingGroupMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMetricFactory.ts", "line": 15 }, "name": "autoScalingGroup", "type": { "fqn": "aws-cdk-lib.aws_autoscaling.IAutoScalingGroup" } } ], "symbolId": "lib/monitoring/aws-ec2/AutoScalingGroupMetricFactory:AutoScalingGroupMetricFactoryProps" }, "cdk-monitoring-constructs.AutoScalingGroupMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AutoScalingGroupMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 42 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AutoScalingGroupMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 30 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 91 }, "name": "createGroupSizeWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 106 }, "name": "createGroupStatusWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 84 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 69 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 76 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "AutoScalingGroupMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 35 }, "name": "groupDesiredSizeMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 34 }, "name": "groupMaxSizeMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 33 }, "name": "groupMinSizeMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 36 }, "name": "instancesInServiceMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 37 }, "name": "instancesPendingMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 38 }, "name": "instancesStandbyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 39 }, "name": "instancesTerminatingMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 40 }, "name": "instancesTotalMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 31 }, "name": "title", "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring:AutoScalingGroupMonitoring" }, "cdk-monitoring-constructs.AutoScalingGroupMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AutoScalingGroupMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 23 }, "name": "AutoScalingGroupMonitoringOptions", "symbolId": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring:AutoScalingGroupMonitoringOptions" }, "cdk-monitoring-constructs.AutoScalingGroupMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AutoScalingGroupMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.AutoScalingGroupMetricFactoryProps", "cdk-monitoring-constructs.AutoScalingGroupMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 26 }, "name": "AutoScalingGroupMonitoringProps", "symbolId": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring:AutoScalingGroupMonitoringProps" }, "cdk-monitoring-constructs.AvailabilityThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AvailabilityThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 33 }, "name": "AvailabilityThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 34 }, "name": "minAvailabilityPercent", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/TaskHealthAlarmFactory:AvailabilityThreshold" }, "cdk-monitoring-constructs.AwsConsoleUrlFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AwsConsoleUrlFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 14 }, "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AwsConsoleUrlFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 10 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 34 }, "name": "getApiGatewayUrl", "parameters": [ { "name": "restApiId", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 19 }, "name": "getAwsConsoleUrl", "parameters": [ { "name": "destinationUrl", "optional": true, "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 40 }, "name": "getCloudFrontDistributionUrl", "parameters": [ { "name": "distributionId", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 45 }, "name": "getCloudWatchLogGroupUrl", "parameters": [ { "name": "logGroupName", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 51 }, "name": "getCodeBuildProjectUrl", "parameters": [ { "name": "projectName", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 57 }, "name": "getDocumentDbClusterUrl", "parameters": [ { "name": "clusterId", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 63 }, "name": "getDynamoTableUrl", "parameters": [ { "name": "tableName", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 69 }, "name": "getElastiCacheClusterUrl", "parameters": [ { "name": "clusterId", "type": { "primitive": "string" } }, { "name": "clusterType", "type": { "fqn": "cdk-monitoring-constructs.ElastiCacheClusterType" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 86 }, "name": "getKinesisAnalyticsUrl", "parameters": [ { "name": "application", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 92 }, "name": "getKinesisDataStreamUrl", "parameters": [ { "name": "streamName", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 98 }, "name": "getKinesisFirehoseDeliveryStreamUrl", "parameters": [ { "name": "streamName", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 104 }, "name": "getLambdaFunctionUrl", "parameters": [ { "name": "functionName", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 110 }, "name": "getOpenSearchClusterUrl", "parameters": [ { "name": "domainName", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 116 }, "name": "getOpenSearchServerlessCollectionUrl", "parameters": [ { "name": "collectionName", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 124 }, "name": "getOsisPipelineUrl", "parameters": [ { "name": "pipelineName", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 130 }, "name": "getRdsClusterUrl", "parameters": [ { "name": "clusterId", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 136 }, "name": "getRdsInstanceUrl", "parameters": [ { "name": "instanceId", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 142 }, "name": "getRedshiftClusterUrl", "parameters": [ { "name": "clusterId", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "see": "https://docs.aws.amazon.com/cdk/latest/guide/tokens.html", "stability": "experimental", "summary": "Resolves a destination URL within a resolution context." }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 178 }, "name": "getResolvedDestinationUrl", "parameters": [ { "docs": { "summary": "The resolution context." }, "name": "context", "type": { "fqn": "aws-cdk-lib.IResolveContext" } }, { "docs": { "summary": "The destination URL to resolve since it may contain CDK tokens." }, "name": "destinationUrl", "type": { "primitive": "string" } } ], "protected": true, "returns": { "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 166 }, "name": "getS3BucketUrl", "parameters": [ { "name": "bucketName", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 148 }, "name": "getSnsTopicUrl", "parameters": [ { "name": "topicArn", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 160 }, "name": "getSqsQueueUrl", "parameters": [ { "name": "queueUrl", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 154 }, "name": "getStateMachineUrl", "parameters": [ { "name": "stateMachineArn", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } } ], "name": "AwsConsoleUrlFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 11 }, "name": "awsAccountId", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 12 }, "name": "awsAccountRegion", "protected": true, "type": { "primitive": "string" } } ], "symbolId": "lib/common/url/AwsConsoleUrlFactory:AwsConsoleUrlFactory" }, "cdk-monitoring-constructs.AwsConsoleUrlFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AwsConsoleUrlFactoryProps", "kind": "interface", "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 5 }, "name": "AwsConsoleUrlFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 6 }, "name": "awsAccountId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/url/AwsConsoleUrlFactory.ts", "line": 7 }, "name": "awsAccountRegion", "type": { "primitive": "string" } } ], "symbolId": "lib/common/url/AwsConsoleUrlFactory:AwsConsoleUrlFactoryProps" }, "cdk-monitoring-constructs.AxisPosition": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AxisPosition", "kind": "enum", "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 39 }, "members": [ { "docs": { "stability": "experimental" }, "name": "LEFT" }, { "docs": { "stability": "experimental" }, "name": "RIGHT" } ], "name": "AxisPosition", "symbolId": "lib/monitoring/custom/CustomMonitoring:AxisPosition" }, "cdk-monitoring-constructs.BaseDlqAlarms": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.BaseDlqAlarms", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts", "line": 31 }, "name": "BaseDlqAlarms", "properties": [ { "abstract": true, "docs": { "remarks": "Note that this corresponds with the NumberOfMessagesSent metric, which does not capture messages sent to the DLQ\nas a result of a failed processing attempt.", "see": "https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html#sqs-dlq-number-of-messages", "stability": "experimental", "summary": "Alarm on the number of messages added to a queue." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts", "line": 50 }, "name": "addDeadLetterQueueMaxIncomingMessagesAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MaxIncomingMessagesCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts", "line": 37 }, "name": "addDeadLetterQueueMaxMessageAgeAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MaxMessageAgeThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts", "line": 32 }, "name": "addDeadLetterQueueMaxSizeAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MaxMessageCountThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq:BaseDlqAlarms" }, "cdk-monitoring-constructs.BaseEc2ServiceAlarms": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.BaseEc2ServiceAlarms", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 57 }, "name": "BaseEc2ServiceAlarms", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 68 }, "name": "addCpuP100UsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 66 }, "name": "addCpuUsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Container Insights needs to be enabled for the cluster for this alarm." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 78 }, "name": "addEphermalStorageUsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 69 }, "name": "addMemoryP100UsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 67 }, "name": "addMemoryUsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Container Insights needs to be enabled for the cluster for this alarm." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 74 }, "name": "addRunningTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.RunningTaskCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Maximum number of tasks, as specified in your auto scaling config." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 65 }, "name": "maxAutoScalingTaskCount", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Minimum number of tasks, as specified in your auto scaling config." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 61 }, "name": "minAutoScalingTaskCount", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring:BaseEc2ServiceAlarms" }, "cdk-monitoring-constructs.BaseFargateServiceAlarms": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.BaseFargateServiceAlarms", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 57 }, "name": "BaseFargateServiceAlarms", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 68 }, "name": "addCpuP100UsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 66 }, "name": "addCpuUsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Container Insights needs to be enabled for the cluster for this alarm." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 78 }, "name": "addEphermalStorageUsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 69 }, "name": "addMemoryP100UsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 67 }, "name": "addMemoryUsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Container Insights needs to be enabled for the cluster for this alarm." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 74 }, "name": "addRunningTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.RunningTaskCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Maximum number of tasks, as specified in your auto scaling config." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 65 }, "name": "maxAutoScalingTaskCount", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Minimum number of tasks, as specified in your auto scaling config." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 61 }, "name": "minAutoScalingTaskCount", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring:BaseFargateServiceAlarms" }, "cdk-monitoring-constructs.BaseFargateServiceMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Monitoring props for any type of Fargate service." }, "fqn": "cdk-monitoring-constructs.BaseFargateServiceMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps", "cdk-monitoring-constructs.BaseFargateServiceAlarms" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 84 }, "name": "BaseFargateServiceMonitoringProps", "symbolId": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring:BaseFargateServiceMonitoringProps" }, "cdk-monitoring-constructs.BaseLoadBalancedFargateServiceMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Base of Monitoring props for load-balanced Fargate service." }, "fqn": "cdk-monitoring-constructs.BaseLoadBalancedFargateServiceMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.BaseFargateServiceMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 99 }, "name": "BaseLoadBalancedFargateServiceMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 101 }, "name": "addHealthyTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.HealthyTaskCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 106 }, "name": "addHealthyTaskPercentAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.HealthyTaskPercentThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 110 }, "name": "addMinProcessedBytesAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MinProcessedBytesThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 102 }, "name": "addUnhealthyTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UnhealthyTaskCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "false", "remarks": "When `invertLoadBalancerTaskCountMetricsStatistics` is set to false, the minimum of `HealthyHostCount` and the maximum of `UnHealthyHostCount` are monitored.\nWhen `invertLoadBalancerTaskCountMetricsStatistics` is set to true, the maximum of `HealthyHostCount` and the minimum of `UnHealthyHostCount` are monitored.\n\n`invertLoadBalancerTaskCountMetricsStatistics` is recommended to set to true as per the guidelines at\nhttps://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-cloudwatch-metrics.html#metric-statistics", "stability": "experimental", "summary": "Invert the statistics of `HealthyHostCount` and `UnHealthyHostCount`." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 126 }, "name": "invertLoadBalancerTaskCountMetricsStatistics", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring:BaseLoadBalancedFargateServiceMonitoringProps" }, "cdk-monitoring-constructs.BaseLoadBalancerMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Base of Monitoring props for load-balancer metric factories." }, "fqn": "cdk-monitoring-constructs.BaseLoadBalancerMetricFactoryProps", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/LoadBalancerMetricFactory.ts", "line": 78 }, "name": "BaseLoadBalancerMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "default": "false", "remarks": "When `invertStatisticsOfTaskCountEnabled` is set to false, the minimum of `HealthyHostCount` and the maximum of `UnHealthyHostCount` are monitored.\nWhen `invertStatisticsOfTaskCountEnabled` is set to true, the maximum of `HealthyHostCount` and the minimum of `UnHealthyHostCount` are monitored.\n\n`invertStatisticsOfTaskCountEnabled` is recommended to set to true as per the guidelines at\nhttps://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-cloudwatch-metrics.html#metric-statistics", "stability": "experimental", "summary": "Invert the statistics of `HealthyHostCount` and `UnHealthyHostCount`." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/LoadBalancerMetricFactory.ts", "line": 90 }, "name": "invertStatisticsOfTaskCountEnabled", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/monitoring/aws-loadbalancing/LoadBalancerMetricFactory:BaseLoadBalancerMetricFactoryProps" }, "cdk-monitoring-constructs.BaseMetricFactory": { "abstract": true, "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.BaseMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/metric/BaseMetricFactory.ts", "line": 26 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.BaseMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/metric/BaseMetricFactory.ts", "line": 21 }, "name": "BaseMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/metric/BaseMetricFactory.ts", "line": 22 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/metric/BaseMetricFactory.ts", "line": 23 }, "name": "account", "optional": true, "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/metric/BaseMetricFactory.ts", "line": 24 }, "name": "region", "optional": true, "protected": true, "type": { "primitive": "string" } } ], "symbolId": "lib/common/metric/BaseMetricFactory:BaseMetricFactory" }, "cdk-monitoring-constructs.BaseMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.BaseMetricFactoryProps", "kind": "interface", "locationInModule": { "filename": "lib/common/metric/BaseMetricFactory.ts", "line": 3 }, "name": "BaseMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "default": "The account configured by the construct holding the Monitoring construct", "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html", "stability": "experimental", "summary": "Account where the metrics exist." }, "immutable": true, "locationInModule": { "filename": "lib/common/metric/BaseMetricFactory.ts", "line": 18 }, "name": "account", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "The region configured by the construct holding the Monitoring construct", "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html", "stability": "experimental", "summary": "Region where the metrics exist." }, "immutable": true, "locationInModule": { "filename": "lib/common/metric/BaseMetricFactory.ts", "line": 10 }, "name": "region", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/common/metric/BaseMetricFactory:BaseMetricFactoryProps" }, "cdk-monitoring-constructs.BaseMonitoringAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.BaseMonitoringAspectType", "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 37 }, "name": "BaseMonitoringAspectType", "properties": [ { "abstract": true, "docs": { "default": "- true", "stability": "experimental", "summary": "If the monitoring aspect is enabled for this resource." }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 42 }, "name": "enabled", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/facade/IMonitoringAspect:BaseMonitoringAspectType" }, "cdk-monitoring-constructs.BaseMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "remarks": "It contains (mostly optional) properties to specify naming, placement, and so on.", "stability": "experimental", "summary": "Base class for properties passed to each monitoring construct." }, "fqn": "cdk-monitoring-constructs.BaseMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps", "cdk-monitoring-constructs.UserProvidedNames", "cdk-monitoring-constructs.MonitoringDashboardsOverrideProps" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/Monitoring.ts", "line": 22 }, "name": "BaseMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Calls provided function to process all alarms created." }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/Monitoring.ts", "line": 29 }, "name": "useCreatedAlarms", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.IAlarmConsumer" } } ], "symbolId": "lib/common/monitoring/Monitoring:BaseMonitoringProps" }, "cdk-monitoring-constructs.BaseQueueProcessingFargateServiceMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.BaseQueueProcessingFargateServiceMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/misc.ts", "line": 27 }, "name": "BaseQueueProcessingFargateServiceMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/misc.ts", "line": 24 }, "name": "addDeadLetterQueueAlarms", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.BaseDlqAlarms" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/misc.ts", "line": 23 }, "name": "addQueueAlarms", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.BaseSqsQueueAlarms" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/misc.ts", "line": 22 }, "name": "addServiceAlarms", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.BaseFargateServiceAlarms" } } ], "symbolId": "lib/monitoring/aws-ecs-patterns/misc:BaseQueueProcessingFargateServiceMonitoringOptions" }, "cdk-monitoring-constructs.BaseServiceMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental", "summary": "Metric factory for a base service (parent class for e.g. Fargate and EC2 services)." }, "fqn": "cdk-monitoring-constructs.BaseServiceMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/BaseServiceMetricFactory.ts", "line": 31 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.BaseServiceMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/BaseServiceMetricFactory.ts", "line": 24 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/BaseServiceMetricFactory.ts", "line": 44 }, "name": "metricClusterCpuUtilisationInPercent", "parameters": [ { "name": "statistic", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MetricStatistic" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/BaseServiceMetricFactory.ts", "line": 60 }, "name": "metricClusterMemoryUtilisationInPercent", "parameters": [ { "name": "statistic", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MetricStatistic" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/BaseServiceMetricFactory.ts", "line": 90 }, "name": "metricEphemeralStorageReserved", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/BaseServiceMetricFactory.ts", "line": 118 }, "name": "metricEphemeralStorageUsageInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/BaseServiceMetricFactory.ts", "line": 104 }, "name": "metricEphemeralStorageUtilized", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/BaseServiceMetricFactory.ts", "line": 76 }, "name": "metricRunningTaskCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "BaseServiceMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/BaseServiceMetricFactory.ts", "line": 25 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "deprecated": "This isn't required by cdk-monitoring-constructs anymore; use your own reference.", "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/BaseServiceMetricFactory.ts", "line": 29 }, "name": "service", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_ecs.IBaseService" } } ], "symbolId": "lib/monitoring/aws-ecs-patterns/BaseServiceMetricFactory:BaseServiceMetricFactory" }, "cdk-monitoring-constructs.BaseServiceMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Props to create BaseServiceMetricFactory." }, "fqn": "cdk-monitoring-constructs.BaseServiceMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/BaseServiceMetricFactory.ts", "line": 17 }, "name": "BaseServiceMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/BaseServiceMetricFactory.ts", "line": 18 }, "name": "service", "type": { "fqn": "aws-cdk-lib.aws_ecs.IBaseService" } } ], "symbolId": "lib/monitoring/aws-ecs-patterns/BaseServiceMetricFactory:BaseServiceMetricFactoryProps" }, "cdk-monitoring-constructs.BaseSqsQueueAlarms": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.BaseSqsQueueAlarms", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 39 }, "name": "BaseSqsQueueAlarms", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 51 }, "name": "addQueueMaxIncomingMessagesAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MaxIncomingMessagesCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 42 }, "name": "addQueueMaxMessageAgeAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MaxMessageAgeThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 41 }, "name": "addQueueMaxSizeAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MaxMessageCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 43 }, "name": "addQueueMaxTimeToDrainMessagesAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MaxTimeToDrainThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 47 }, "name": "addQueueMinIncomingMessagesAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MinIncomingMessagesCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 40 }, "name": "addQueueMinSizeAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MinMessageCountThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-sqs/SqsQueueMonitoring:BaseSqsQueueAlarms" }, "cdk-monitoring-constructs.BillingAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.BillingAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 69 }, "name": "BillingAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 70 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.BillingMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:BillingAspectType" }, "cdk-monitoring-constructs.BillingMetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.BillingMetricFactory", "initializer": { "docs": { "stability": "experimental" } }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-billing/BillingMetricFactory.ts", "line": 14 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-billing/BillingMetricFactory.ts", "line": 15 }, "name": "metricSearchTopCostByServiceInUsd", "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-billing/BillingMetricFactory.ts", "line": 33 }, "name": "metricTotalCostInUsd", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "BillingMetricFactory", "symbolId": "lib/monitoring/aws-billing/BillingMetricFactory:BillingMetricFactory" }, "cdk-monitoring-constructs.BillingMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.BillingMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-billing/BillingMonitoring.ts", "line": 49 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.BillingMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-billing/BillingMonitoring.ts", "line": 40 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-billing/BillingMonitoring.ts", "line": 108 }, "name": "createChargesByServiceWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-billing/BillingMonitoring.ts", "line": 101 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-billing/BillingMonitoring.ts", "line": 121 }, "name": "createTotalChargesWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.SingleValueWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-billing/BillingMonitoring.ts", "line": 83 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-billing/BillingMonitoring.ts", "line": 90 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "BillingMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-billing/BillingMonitoring.ts", "line": 43 }, "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-billing/BillingMonitoring.ts", "line": 44 }, "name": "anomalyDetectingAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AnomalyDetectingAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-billing/BillingMonitoring.ts", "line": 46 }, "name": "costByServiceMetric", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-billing/BillingMonitoring.ts", "line": 41 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-billing/BillingMonitoring.ts", "line": 47 }, "name": "totalCostMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } ], "symbolId": "lib/monitoring/aws-billing/BillingMonitoring:BillingMonitoring" }, "cdk-monitoring-constructs.BillingMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.BillingMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-billing/BillingMonitoring.ts", "line": 34 }, "name": "BillingMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-billing/BillingMonitoring.ts", "line": 35 }, "name": "addTotalCostAnomalyAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.AnomalyDetectionThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-billing/BillingMonitoring:BillingMonitoringOptions" }, "cdk-monitoring-constructs.BillingMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.BillingMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.BillingMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-billing/BillingMonitoring.ts", "line": 38 }, "name": "BillingMonitoringProps", "symbolId": "lib/monitoring/aws-billing/BillingMonitoring:BillingMonitoringProps" }, "cdk-monitoring-constructs.BitmapDashboard": { "assembly": "cdk-monitoring-constructs", "base": "aws-cdk-lib.aws_cloudwatch.Dashboard", "docs": { "stability": "experimental", "summary": "Specific subtype of dashboard that renders supported widgets as bitmaps, while preserving the overall layout." }, "fqn": "cdk-monitoring-constructs.BitmapDashboard", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/BitmapDashboard.ts", "line": 19 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.DashboardProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/dashboard/BitmapDashboard.ts", "line": 16 }, "methods": [ { "docs": { "remarks": "Widgets given in multiple calls to add() will be laid out stacked on\ntop of each other.\n\nMultiple widgets added in the same call to add() will be laid out next\nto each other.", "stability": "experimental", "summary": "Add a widget to the dashboard." }, "locationInModule": { "filename": "lib/dashboard/BitmapDashboard.ts", "line": 27 }, "name": "addWidgets", "overrides": "aws-cdk-lib.aws_cloudwatch.Dashboard", "parameters": [ { "name": "widgets", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/BitmapDashboard.ts", "line": 31 }, "name": "asBitmap", "parameters": [ { "name": "widget", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/BitmapDashboard.ts", "line": 49 }, "name": "asBitmaps", "parameters": [ { "name": "widgets", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "variadic": true } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } }, "variadic": true } ], "name": "BitmapDashboard", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/BitmapDashboard.ts", "line": 17 }, "name": "bitmapRenderingSupport", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.BitmapWidgetRenderingSupport" } } ], "symbolId": "lib/dashboard/BitmapDashboard:BitmapDashboard" }, "cdk-monitoring-constructs.BitmapWidgetRenderingSupport": { "assembly": "cdk-monitoring-constructs", "base": "constructs.Construct", "docs": { "remarks": "It is a custom widget lambda with some additional roles and helper methods.", "stability": "experimental", "summary": "Support for rendering bitmap widgets on the server side." }, "fqn": "cdk-monitoring-constructs.BitmapWidgetRenderingSupport", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/widget/BitmapWidget.ts", "line": 24 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/dashboard/widget/BitmapWidget.ts", "line": 21 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/widget/BitmapWidget.ts", "line": 61 }, "name": "asBitmap", "parameters": [ { "name": "widget", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.CustomWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/widget/BitmapWidget.ts", "line": 80 }, "name": "getWidgetProperties", "parameters": [ { "name": "widget", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" } } ], "protected": true, "returns": { "type": { "primitive": "any" } } } ], "name": "BitmapWidgetRenderingSupport", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/BitmapWidget.ts", "line": 22 }, "name": "handler", "type": { "fqn": "aws-cdk-lib.aws_lambda.IFunction" } } ], "symbolId": "lib/dashboard/widget/BitmapWidget:BitmapWidgetRenderingSupport" }, "cdk-monitoring-constructs.CapacityType": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CapacityType", "kind": "enum", "locationInModule": { "filename": "lib/common/monitoring/alarms/DynamoAlarmFactory.ts", "line": 9 }, "members": [ { "docs": { "stability": "experimental" }, "name": "READ" }, { "docs": { "stability": "experimental" }, "name": "WRITE" } ], "name": "CapacityType", "symbolId": "lib/common/monitoring/alarms/DynamoAlarmFactory:CapacityType" }, "cdk-monitoring-constructs.CertificateManagerAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CertificateManagerAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 45 }, "name": "CertificateManagerAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 46 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.CertificateManagerMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:CertificateManagerAspectType" }, "cdk-monitoring-constructs.CertificateManagerMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CertificateManagerMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMetricFactory.ts", "line": 22 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.CertificateManagerMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMetricFactory.ts", "line": 19 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMetricFactory.ts", "line": 33 }, "name": "metricDaysToExpiry", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "CertificateManagerMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMetricFactory.ts", "line": 20 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-acm/CertificateManagerMetricFactory:CertificateManagerMetricFactory" }, "cdk-monitoring-constructs.CertificateManagerMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CertificateManagerMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMetricFactory.ts", "line": 14 }, "name": "CertificateManagerMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMetricFactory.ts", "line": 16 }, "name": "certificate", "type": { "fqn": "aws-cdk-lib.aws_certificatemanager.ICertificate" } } ], "symbolId": "lib/monitoring/aws-acm/CertificateManagerMetricFactory:CertificateManagerMetricFactoryProps" }, "cdk-monitoring-constructs.CertificateManagerMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CertificateManagerMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMonitoring.ts", "line": 42 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.CertificateManagerMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMonitoring.ts", "line": 36 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMonitoring.ts", "line": 94 }, "name": "createDaysToExpiryWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMonitoring.ts", "line": 87 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMonitoring.ts", "line": 76 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMonitoring.ts", "line": 80 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "CertificateManagerMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMonitoring.ts", "line": 39 }, "name": "daysToExpiryAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMonitoring.ts", "line": 40 }, "name": "daysToExpiryMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMonitoring.ts", "line": 37 }, "name": "title", "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-acm/CertificateManagerMonitoring:CertificateManagerMonitoring" }, "cdk-monitoring-constructs.CertificateManagerMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CertificateManagerMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMonitoring.ts", "line": 27 }, "name": "CertificateManagerMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMonitoring.ts", "line": 29 }, "name": "addDaysToExpiryAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DaysToExpiryThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-acm/CertificateManagerMonitoring:CertificateManagerMonitoringOptions" }, "cdk-monitoring-constructs.CertificateManagerMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CertificateManagerMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.CertificateManagerMonitoringOptions", "cdk-monitoring-constructs.CertificateManagerMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMonitoring.ts", "line": 32 }, "name": "CertificateManagerMonitoringProps", "symbolId": "lib/monitoring/aws-acm/CertificateManagerMonitoring:CertificateManagerMonitoringProps" }, "cdk-monitoring-constructs.ChangeInSecretCountThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ChangeInSecretCountThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/SecretsManagerAlarmFactory.ts", "line": 19 }, "name": "ChangeInSecretCountThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/SecretsManagerAlarmFactory.ts", "line": 22 }, "name": "alarmWhenDecreased", "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/SecretsManagerAlarmFactory.ts", "line": 21 }, "name": "alarmWhenIncreased", "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/SecretsManagerAlarmFactory.ts", "line": 20 }, "name": "requiredSecretCount", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/SecretsManagerAlarmFactory.ts", "line": 23 }, "name": "additionalDescription", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/common/monitoring/alarms/SecretsManagerAlarmFactory:ChangeInSecretCountThreshold" }, "cdk-monitoring-constructs.CloudFrontAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CloudFrontAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 73 }, "name": "CloudFrontAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 74 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.CloudFrontDistributionMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:CloudFrontAspectType" }, "cdk-monitoring-constructs.CloudFrontDistributionMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "remarks": "Virginia) Region (us-east-1).\nhttps://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/programming-cloudwatch-metrics.html", "stability": "experimental", "summary": "To get the CloudFront metrics from the CloudWatch API, you must use the US East (N." }, "fqn": "cdk-monitoring-constructs.CloudFrontDistributionMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 50 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.CloudFrontDistributionMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 45 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 143 }, "name": "metric4xxErrorRateAverage", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 157 }, "name": "metric5xxErrorRateAverage", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "remarks": "This is an additional metric that needs to be explicitly enabled for an additional cost.", "see": "https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/viewing-cloudfront-metrics.html#monitoring-console.distributions-additional", "stability": "experimental", "summary": "Cache hit rate metric." }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 129 }, "name": "metricCacheHitRateAverageInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 65 }, "name": "metricRequestCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 79 }, "name": "metricRequestRate", "parameters": [ { "name": "rateComputationMethod", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "deprecated": "use metricRequestRate", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 92 }, "name": "metricRequestTps", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 110 }, "name": "metricTotalBytesDownloaded", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 96 }, "name": "metricTotalBytesUploaded", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 171 }, "name": "metricTotalErrorRateAverage", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "CloudFrontDistributionMetricFactory", "symbolId": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory:CloudFrontDistributionMetricFactory" }, "cdk-monitoring-constructs.CloudFrontDistributionMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CloudFrontDistributionMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 16 }, "name": "CloudFrontDistributionMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 18 }, "name": "distribution", "type": { "fqn": "aws-cdk-lib.aws_cloudfront.IDistribution" } }, { "abstract": true, "docs": { "default": "- true", "remarks": "To enable additional metrics on your CloudFront distribution, see\nhttps://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/viewing-cloudfront-metrics.html#monitoring-console.distributions-additional", "stability": "experimental", "summary": "Generate dashboard charts for additional CloudFront distribution metrics." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 38 }, "name": "additionalMetricsEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- true", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 23 }, "name": "fillTpsWithZeroes", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- average", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 28 }, "name": "rateComputationMethod", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory:CloudFrontDistributionMetricFactoryProps" }, "cdk-monitoring-constructs.CloudFrontDistributionMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CloudFrontDistributionMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 72 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.CloudFrontDistributionMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 51 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 211 }, "name": "createCacheWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 232 }, "name": "createErrorRateWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 192 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 200 }, "name": "createTpsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 222 }, "name": "createTrafficWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 165 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 173 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "CloudFrontDistributionMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 69 }, "name": "additionalMetricsEnabled", "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 56 }, "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 64 }, "name": "downloadedBytesMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 66 }, "name": "error4xxRate", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 67 }, "name": "error5xxRate", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 57 }, "name": "errorAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 60 }, "name": "errorRateAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 55 }, "name": "namingStrategy", "type": { "fqn": "cdk-monitoring-constructs.MonitoringNamingStrategy" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 52 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 58 }, "name": "tpsAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.TpsAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 61 }, "name": "tpsAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 63 }, "name": "tpsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 65 }, "name": "uploadedBytesMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 70 }, "name": "cacheHitRate", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 53 }, "name": "distributionUrl", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring:CloudFrontDistributionMonitoring" }, "cdk-monitoring-constructs.CloudFrontDistributionMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CloudFrontDistributionMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 38 }, "name": "CloudFrontDistributionMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 40 }, "name": "addError4xxRate", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 41 }, "name": "addFault5xxRate", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 44 }, "name": "addHighTpsAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.HighTpsThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 43 }, "name": "addLowTpsAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LowTpsThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring:CloudFrontDistributionMonitoringOptions" }, "cdk-monitoring-constructs.CloudFrontDistributionMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CloudFrontDistributionMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.CloudFrontDistributionMetricFactoryProps", "cdk-monitoring-constructs.CloudFrontDistributionMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 47 }, "name": "CloudFrontDistributionMonitoringProps", "symbolId": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring:CloudFrontDistributionMonitoringProps" }, "cdk-monitoring-constructs.CloudWatchLogsMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CloudWatchLogsMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/CloudWatchLogsMetricFactory.ts", "line": 23 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.CloudWatchLogsMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/CloudWatchLogsMetricFactory.ts", "line": 20 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/CloudWatchLogsMetricFactory.ts", "line": 34 }, "name": "metricIncomingLogEvents", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "CloudWatchLogsMetricFactory", "symbolId": "lib/monitoring/aws-cloudwatch/CloudWatchLogsMetricFactory:CloudWatchLogsMetricFactory" }, "cdk-monitoring-constructs.CloudWatchLogsMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CloudWatchLogsMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/CloudWatchLogsMetricFactory.ts", "line": 12 }, "name": "CloudWatchLogsMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Name of the log group to monitor." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/CloudWatchLogsMetricFactory.ts", "line": 17 }, "name": "logGroupName", "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-cloudwatch/CloudWatchLogsMetricFactory:CloudWatchLogsMetricFactoryProps" }, "cdk-monitoring-constructs.CodeBuildAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CodeBuildAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 77 }, "name": "CodeBuildAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 78 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.CodeBuildProjectMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:CodeBuildAspectType" }, "cdk-monitoring-constructs.CodeBuildProjectMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CodeBuildProjectMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 20 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.CodeBuildProjectMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 16 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 32 }, "name": "metricBuildCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 87 }, "name": "metricDurationP50InSeconds", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 76 }, "name": "metricDurationP90InSeconds", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 65 }, "name": "metricDurationP99InSeconds", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 50 }, "name": "metricFailedBuildCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 59 }, "name": "metricFailedBuildRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 41 }, "name": "metricSucceededBuildCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "CodeBuildProjectMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 17 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 18 }, "name": "project", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_codebuild.IProject" } } ], "symbolId": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory:CodeBuildProjectMetricFactory" }, "cdk-monitoring-constructs.CodeBuildProjectMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CodeBuildProjectMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 11 }, "name": "CodeBuildProjectMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 13 }, "name": "project", "type": { "fqn": "aws-cdk-lib.aws_codebuild.IProject" } } ], "symbolId": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory:CodeBuildProjectMetricFactoryProps" }, "cdk-monitoring-constructs.CodeBuildProjectMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CodeBuildProjectMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 69 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.CodeBuildProjectMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 51 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 198 }, "name": "createBuildCountsWidget", "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 213 }, "name": "createDurationWidget", "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 228 }, "name": "createFailedBuildRateWidget", "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 190 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 239 }, "name": "resolveProjectName", "parameters": [ { "name": "project", "type": { "fqn": "aws-cdk-lib.aws_codebuild.IProject" } } ], "protected": true, "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 185 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 176 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "CodeBuildProjectMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 61 }, "name": "buildCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 56 }, "name": "durationAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 57 }, "name": "durationAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 67 }, "name": "durationP50InSecondsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 66 }, "name": "durationP90InSecondsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 65 }, "name": "durationP99InSecondsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 55 }, "name": "errorAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 58 }, "name": "errorCountAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 59 }, "name": "errorRateAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 63 }, "name": "failedBuildCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 64 }, "name": "failedBuildRateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 62 }, "name": "succeededBuildCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 52 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 53 }, "name": "projectUrl", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring:CodeBuildProjectMonitoring" }, "cdk-monitoring-constructs.CodeBuildProjectMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CodeBuildProjectMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 35 }, "name": "CodeBuildProjectMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 38 }, "name": "addDurationP50Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DurationThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 37 }, "name": "addDurationP90Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DurationThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 36 }, "name": "addDurationP99Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DurationThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 40 }, "name": "addFailedBuildCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 41 }, "name": "addFailedBuildRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring:CodeBuildProjectMonitoringOptions" }, "cdk-monitoring-constructs.CodeBuildProjectMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Monitoring props for CodeBuild projects." }, "fqn": "cdk-monitoring-constructs.CodeBuildProjectMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.CodeBuildProjectMetricFactoryProps", "cdk-monitoring-constructs.CodeBuildProjectMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 47 }, "name": "CodeBuildProjectMonitoringProps", "symbolId": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring:CodeBuildProjectMonitoringProps" }, "cdk-monitoring-constructs.CompositeAlarmOperator": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CompositeAlarmOperator", "kind": "enum", "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 455 }, "members": [ { "docs": { "stability": "experimental", "summary": "trigger only if all the alarms are triggered." }, "name": "AND" }, { "docs": { "stability": "experimental", "summary": "trigger if any of the alarms is triggered." }, "name": "OR" } ], "name": "CompositeAlarmOperator", "symbolId": "lib/common/alarm/AlarmFactory:CompositeAlarmOperator" }, "cdk-monitoring-constructs.CompositeMetricAdjuster": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental", "summary": "Allows to apply a collection of {@link IMetricAdjuster} to a metric." }, "fqn": "cdk-monitoring-constructs.CompositeMetricAdjuster", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/metric-adjuster/CompositeMetricAdjuster.ts", "line": 10 }, "parameters": [ { "name": "adjusters", "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.IMetricAdjuster" }, "kind": "array" } } } ] }, "interfaces": [ "cdk-monitoring-constructs.IMetricAdjuster" ], "kind": "class", "locationInModule": { "filename": "lib/common/alarm/metric-adjuster/CompositeMetricAdjuster.ts", "line": 9 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/metric-adjuster/CompositeMetricAdjuster.ts", "line": 12 }, "name": "of", "parameters": [ { "name": "adjusters", "type": { "fqn": "cdk-monitoring-constructs.IMetricAdjuster" }, "variadic": true } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.CompositeMetricAdjuster" } }, "static": true, "variadic": true }, { "docs": { "custom": { "inheritdoc": "true" }, "stability": "experimental", "summary": "Adjusts a metric." }, "locationInModule": { "filename": "lib/common/alarm/metric-adjuster/CompositeMetricAdjuster.ts", "line": 17 }, "name": "adjustMetric", "overrides": "cdk-monitoring-constructs.IMetricAdjuster", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "alarmScope", "type": { "fqn": "constructs.Construct" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AddAlarmProps" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "CompositeMetricAdjuster", "symbolId": "lib/common/alarm/metric-adjuster/CompositeMetricAdjuster:CompositeMetricAdjuster" }, "cdk-monitoring-constructs.ConnectionAlarmFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ConnectionAlarmFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/ConnectionAlarmFactory.ts", "line": 20 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/ConnectionAlarmFactory.ts", "line": 17 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/ConnectionAlarmFactory.ts", "line": 43 }, "name": "addMaxConnectionCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.HighConnectionCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/ConnectionAlarmFactory.ts", "line": 24 }, "name": "addMinConnectionCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.LowConnectionCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } } ], "name": "ConnectionAlarmFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/ConnectionAlarmFactory.ts", "line": 18 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ], "symbolId": "lib/common/monitoring/alarms/ConnectionAlarmFactory:ConnectionAlarmFactory" }, "cdk-monitoring-constructs.ConsumedCapacityThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ConsumedCapacityThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/DynamoAlarmFactory.ts", "line": 14 }, "name": "ConsumedCapacityThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/DynamoAlarmFactory.ts", "line": 15 }, "name": "maxConsumedCapacityUnits", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/DynamoAlarmFactory:ConsumedCapacityThreshold" }, "cdk-monitoring-constructs.ConsumerRateExceededThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ConsumerRateExceededThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 28 }, "name": "ConsumerRateExceededThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Threshold for SubscribeToShard.RateExceeded average (0.0–1.0)." }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 30 }, "name": "maxRateExceeded", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/KinesisAlarmFactory:ConsumerRateExceededThreshold" }, "cdk-monitoring-constructs.CustomAlarmFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CustomAlarmFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/CustomAlarmFactory.ts", "line": 19 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/CustomAlarmFactory.ts", "line": 16 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/CustomAlarmFactory.ts", "line": 23 }, "name": "addCustomAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "alarmNameSuffix", "type": { "primitive": "string" } }, { "name": "disambiguator", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.CustomThreshold" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } } ], "name": "CustomAlarmFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/CustomAlarmFactory.ts", "line": 17 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ], "symbolId": "lib/common/monitoring/alarms/CustomAlarmFactory:CustomAlarmFactory" }, "cdk-monitoring-constructs.CustomAlarmThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Common customization that can be attached to each alarm." }, "fqn": "cdk-monitoring-constructs.CustomAlarmThreshold", "kind": "interface", "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 13 }, "name": "CustomAlarmThreshold", "properties": [ { "abstract": true, "docs": { "default": "- undefined (default action will be used, if any)", "stability": "experimental", "summary": "Allows to override the default alarm action." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 19 }, "name": "actionOverride", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.IAlarmActionStrategy" } }, { "abstract": true, "docs": { "default": "- the same as monitoring facade default", "stability": "experimental", "summary": "Enables the configured CloudWatch alarm ticketing actions." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 134 }, "name": "actionsEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- undefined (no suffix)", "remarks": "This allows you to specify the same dedupe string for a family of alarms.\nCannot be defined at the same time as dedupeStringOverride.", "stability": "experimental", "summary": "If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 49 }, "name": "alarmDedupeStringSuffix", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- default auto-generated content only", "stability": "experimental", "summary": "A text included in the generated ticket description body, which fully replaces the generated text." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 40 }, "name": "alarmDescriptionOverride", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually.", "stability": "experimental", "summary": "If this is defined, the alarm name is set to this exact value." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 33 }, "name": "alarmNameOverride", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- alarm-specific default", "stability": "experimental", "summary": "Comparison operator used to compare actual value against the threshold." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 111 }, "name": "comparisonOperatorOverride", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.ComparisonOperator" } }, { "abstract": true, "docs": { "default": "- no parameters", "stability": "experimental", "summary": "This allows user to attach custom parameters to this alarm, which can later be accessed from the \"useCreatedAlarms\" method." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 104 }, "name": "customParams", "optional": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- no tags", "stability": "experimental", "summary": "This allows user to attach custom values to this alarm, which can later be accessed from the \"useCreatedAlarms\" method." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 97 }, "name": "customTags", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- the same as monitoring facade default", "stability": "experimental", "summary": "Number of breaches required to transition into an ALARM state." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 141 }, "name": "datapointsToAlarm", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- undefined (no override)", "remarks": "Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually.", "stability": "experimental", "summary": "If this is defined, the alarm dedupe string is set to this exact value." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 27 }, "name": "dedupeStringOverride", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no additional link will be added", "stability": "experimental", "summary": "An optional link included in the generated ticket description body." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 162 }, "name": "documentationLink", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- true", "remarks": "If you specify false, the alarm state does not change during periods with too few data points to be statistically significant.\nIf you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available.", "stability": "experimental", "summary": "Used only for alarms based on percentiles." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 127 }, "name": "evaluateLowSampleCountPercentile", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- the same as monitoring facade default", "stability": "experimental", "summary": "Number of periods to consider when checking the number of breaching datapoints." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 148 }, "name": "evaluationPeriods", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- false", "stability": "experimental", "summary": "Indicates whether the alarming range of values should be highlighted in the widget." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 176 }, "name": "fillAlarmRange", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no adjuster", "stability": "experimental", "summary": "If specified, adjusts the metric before creating an alarm from it." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 204 }, "name": "metricAdjuster", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.IMetricAdjuster" } }, { "abstract": true, "docs": { "default": "- default behaviour - no condition on sample count will be added to the alarm", "deprecated": "Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation\nperiod for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has\nsufficient number of samples", "remarks": "If this property is specified, a composite alarm is created of the following:\n\nThis composite alarm will be returned as a result and uses the specified alarm actions.", "stability": "deprecated", "summary": "Specifies how many samples (N) of the metric is needed to trigger the alarm." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 90 }, "name": "minMetricSamplesToAlarm", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- default behaviour - no condition on sample count will be used", "remarks": "If this property is specified, your metric will be subject to MathExpression that will add an IF condition\nto your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples.\nIf the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated\naccording to the treatMissingData parameter.\nIf specified, deprecated minMetricSamplesToAlarm has no effect.", "stability": "experimental", "summary": "Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 61 }, "name": "minSampleCountToEvaluateDatapoint", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- no override (default color)", "stability": "experimental", "summary": "If specified, it modifies the final alarm annotation color." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 183 }, "name": "overrideAnnotationColor", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no override (default label)", "stability": "experimental", "summary": "If specified, it modifies the final alarm annotation label." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 190 }, "name": "overrideAnnotationLabel", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no override (default visibility)", "stability": "experimental", "summary": "If specified, it modifies the final alarm annotation visibility." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 197 }, "name": "overrideAnnotationVisibility", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- the default specified in MetricFactory", "stability": "experimental", "summary": "Period override for the metric to alarm on." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 155 }, "name": "period", "optional": true, "type": { "fqn": "aws-cdk-lib.Duration" } }, { "abstract": true, "docs": { "default": "- no additional link will be added", "stability": "experimental", "summary": "An optional link included in the generated ticket description body." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 169 }, "name": "runbookLink", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics\nproperty that should be used as the sampleCount metric for the new MathExpression as described in the documentation\nfor minSampleCountToEvaluateDatapoint.", "stability": "experimental", "summary": "This property is required in the following situation:
  1. minSampleCountToEvaluateDatapoint is specified
  2. the metric used for the alarm is a MathExpression
  3. the MathExpression is composed of more than one metric
." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 75 }, "name": "sampleCountMetricId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- alarm-specific default", "stability": "experimental", "summary": "Behaviour in case the metric data is missing." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/CustomAlarmThreshold.ts", "line": 118 }, "name": "treatMissingDataOverride", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData" } } ], "symbolId": "lib/common/alarm/CustomAlarmThreshold:CustomAlarmThreshold" }, "cdk-monitoring-constructs.CustomEc2ServiceMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CustomEc2ServiceMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps", "cdk-monitoring-constructs.BaseEc2ServiceAlarms" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 157 }, "name": "CustomEc2ServiceMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 159 }, "name": "ec2Service", "type": { "fqn": "aws-cdk-lib.aws_ecs.IBaseService" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 101 }, "name": "addHealthyTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.HealthyTaskCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 106 }, "name": "addHealthyTaskPercentAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.HealthyTaskPercentThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 110 }, "name": "addMinProcessedBytesAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MinProcessedBytesThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 102 }, "name": "addUnhealthyTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UnhealthyTaskCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "false", "remarks": "When `invertLoadBalancerTaskCountMetricsStatistics` is set to false, the minimum of `HealthyHostCount` and the maximum of `UnHealthyHostCount` are monitored.\nWhen `invertLoadBalancerTaskCountMetricsStatistics` is set to true, the maximum of `HealthyHostCount` and the minimum of `UnHealthyHostCount` are monitored.\n\n`invertLoadBalancerTaskCountMetricsStatistics` is recommended to set to true as per the guidelines at\nhttps://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-cloudwatch-metrics.html#metric-statistics", "stability": "experimental", "summary": "Invert the statistics of `HealthyHostCount` and `UnHealthyHostCount`." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 126 }, "name": "invertLoadBalancerTaskCountMetricsStatistics", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 160 }, "name": "loadBalancer", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.INetworkLoadBalancer" }, { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer" } ] } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 161 }, "name": "targetGroup", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.INetworkTargetGroup" }, { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationTargetGroup" } ] } } } ], "symbolId": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring:CustomEc2ServiceMonitoringProps" }, "cdk-monitoring-constructs.CustomFargateServiceMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CustomFargateServiceMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.BaseLoadBalancedFargateServiceMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 157 }, "name": "CustomFargateServiceMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 159 }, "name": "fargateService", "type": { "fqn": "aws-cdk-lib.aws_ecs.IBaseService" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 160 }, "name": "loadBalancer", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.INetworkLoadBalancer" }, { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer" } ] } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 161 }, "name": "targetGroup", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.INetworkTargetGroup" }, { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationTargetGroup" } ] } } } ], "symbolId": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring:CustomFargateServiceMonitoringProps" }, "cdk-monitoring-constructs.CustomMetricGroup": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Custom metric group represents a single widget." }, "fqn": "cdk-monitoring-constructs.CustomMetricGroup", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 164 }, "name": "CustomMetricGroup", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "list of metrics in the group (can be defined in different ways, see the type documentation)." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 213 }, "name": "metrics", "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "cdk-monitoring-constructs.CustomMetricWithAlarm" }, { "fqn": "cdk-monitoring-constructs.CustomMetricWithAnomalyDetection" }, { "fqn": "cdk-monitoring-constructs.CustomMetricSearch" } ] } }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "title of the whole group." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 168 }, "name": "title", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- addToSummaryDashboard from CustomMonitoringProps, defaulting to false", "stability": "experimental", "summary": "Flag indicating this metric group should be included in the summary as well." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 209 }, "name": "addToSummaryDashboard", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "undefined", "stability": "experimental", "summary": "optional axis." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 178 }, "name": "graphWidgetAxis", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.YAxisProps" } }, { "abstract": true, "docs": { "default": "BOTTOM", "stability": "experimental", "summary": "graph widget legend." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 188 }, "name": "graphWidgetLegend", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.LegendPosition" } }, { "abstract": true, "docs": { "default": "undefined", "stability": "experimental", "summary": "optional right axis." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 183 }, "name": "graphWidgetRightAxis", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.YAxisProps" } }, { "abstract": true, "docs": { "see": "{GraphWidgetProps.setPeriodToTimeRange}", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 192 }, "name": "graphWidgetSetPeriodToTimeRange", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "line", "stability": "experimental", "summary": "type of the widget." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 173 }, "name": "graphWidgetType", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.GraphWidgetType" } }, { "abstract": true, "docs": { "default": "- Automatically calculcated width, generally as wide as possible considering all metrics' widgets.", "remarks": "Note that widgets will overflow into new rows if the summed width\nexceeds 24.", "stability": "experimental", "summary": "Width of graph widget." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 199 }, "name": "graphWidgetWidth", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Optional custom horizontal annotations which will be displayed over the metrics on the left axis (if there are any alarms, any existing annotations will be merged together)." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 218 }, "name": "horizontalAnnotations", "optional": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Optional custom horizontal annotations which will be displayed over the metrics on the right axis (if there are any alarms, any existing annotations will be merged together)." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 223 }, "name": "horizontalRightAnnotations", "optional": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "abstract": true, "docs": { "deprecated": "use addToSummaryDashboard. addToSummaryDashboard will take precedence over important.", "see": "addToSummaryDashboard", "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 204 }, "name": "important", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Optional custom vertical annotations which will be displayed over the metrics." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 227 }, "name": "verticalAnnotations", "optional": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.VerticalAnnotation" }, "kind": "array" } } } ], "symbolId": "lib/monitoring/custom/CustomMonitoring:CustomMetricGroup" }, "cdk-monitoring-constructs.CustomMetricGroupWithAnnotations": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CustomMetricGroupWithAnnotations", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 255 }, "name": "CustomMetricGroupWithAnnotations", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 257 }, "name": "annotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 256 }, "name": "metricGroup", "type": { "fqn": "cdk-monitoring-constructs.CustomMetricGroup" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 258 }, "name": "rightAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 260 }, "name": "titleAddons", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 259 }, "name": "verticalAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.VerticalAnnotation" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 261 }, "name": "height", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/monitoring/custom/CustomMonitoring:CustomMetricGroupWithAnnotations" }, "cdk-monitoring-constructs.CustomMetricSearch": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Custom metric search." }, "fqn": "cdk-monitoring-constructs.CustomMetricSearch", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 97 }, "name": "CustomMetricSearch", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "search dimensions (can be empty)." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 115 }, "name": "dimensionsMap", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "search query (can be empty)." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 106 }, "name": "searchQuery", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "metric statistic." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 119 }, "name": "statistic", "type": { "fqn": "cdk-monitoring-constructs.MetricStatistic" } }, { "abstract": true, "docs": { "default": "- Deployment account.", "remarks": "Note that alarms cannot be created for cross-account metrics.", "stability": "experimental", "summary": "Account which this metric comes from." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 137 }, "name": "account", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- \" \"", "stability": "experimental", "summary": "custom label for the metrics." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 111 }, "name": "label", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- none", "stability": "experimental", "summary": "metric namespace." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 102 }, "name": "namespace", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- global default", "stability": "experimental", "summary": "metric period." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 124 }, "name": "period", "optional": true, "type": { "fqn": "aws-cdk-lib.Duration" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "axis (right or left) on which to graph metric default: AxisPosition.LEFT." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 129 }, "name": "position", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.AxisPosition" } }, { "abstract": true, "docs": { "default": "- Deployment region.", "remarks": "Note that alarms cannot be created for cross-region metrics.", "stability": "experimental", "summary": "Region which this metric comes from." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 145 }, "name": "region", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/custom/CustomMonitoring:CustomMetricSearch" }, "cdk-monitoring-constructs.CustomMetricWithAlarm": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Custom metric with an alarm defined." }, "fqn": "cdk-monitoring-constructs.CustomMetricWithAlarm", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 47 }, "name": "CustomMetricWithAlarm", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "alarm definitions." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 59 }, "name": "addAlarm", "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.CustomThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "alarm friendly name." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 55 }, "name": "alarmFriendlyName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "metric to alarm on." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 51 }, "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "axis (right or left) on which to graph metric default: AxisPosition.LEFT." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 64 }, "name": "position", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.AxisPosition" } } ], "symbolId": "lib/monitoring/custom/CustomMonitoring:CustomMetricWithAlarm" }, "cdk-monitoring-constructs.CustomMetricWithAnomalyDetection": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Custom metric with anomaly detection." }, "fqn": "cdk-monitoring-constructs.CustomMetricWithAnomalyDetection", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 70 }, "name": "CustomMetricWithAnomalyDetection", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "alarm friendly name." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 83 }, "name": "alarmFriendlyName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "standard deviation for the anomaly detection to be rendered on the graph widget." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 87 }, "name": "anomalyDetectionStandardDeviationToRender", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "metric to alarm on." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 74 }, "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "adds alarm on a detected anomaly." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 91 }, "name": "addAlarmOnAnomaly", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.AnomalyDetectionThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- metric period (if defined) or global default", "stability": "experimental", "summary": "anomaly detection period." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 79 }, "name": "period", "optional": true, "type": { "fqn": "aws-cdk-lib.Duration" } } ], "symbolId": "lib/monitoring/custom/CustomMonitoring:CustomMetricWithAnomalyDetection" }, "cdk-monitoring-constructs.CustomMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "remarks": "The entire construct consists of metric groups.\nEach metric group represents a single graph widget with multiple metrics.\nEach metric inside the metric group represents a single metric inside a graph.\nThe widgets will be sized automatically to waste as little space as possible.", "stability": "experimental", "summary": "Custom monitoring is a construct allowing you to monitor your own custom metrics." }, "fqn": "cdk-monitoring-constructs.CustomMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 281 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.CustomMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 271 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 345 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 349 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "CustomMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 276 }, "name": "addToSummaryDashboard", "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 278 }, "name": "anomalyDetectingAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AnomalyDetectingAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 277 }, "name": "customAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.CustomAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 279 }, "name": "metricGroups", "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.CustomMetricGroupWithAnnotations" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 272 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 273 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 274 }, "name": "descriptionWidgetHeight", "optional": true, "type": { "primitive": "number" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 275 }, "name": "height", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/monitoring/custom/CustomMonitoring:CustomMonitoring" }, "cdk-monitoring-constructs.CustomMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CustomMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 230 }, "name": "CustomMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "define metric groups and metrics inside them (each metric group represents a widget)." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 252 }, "name": "metricGroups", "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.CustomMetricGroup" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- no description", "stability": "experimental", "summary": "optional description of the whole section, in markdown." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 236 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- minimum height (should fit one or two lines of text)", "stability": "experimental", "summary": "optional height of the description widget, so the content fits." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 242 }, "name": "descriptionWidgetHeight", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- default height", "stability": "experimental", "summary": "Height override." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 248 }, "name": "height", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/monitoring/custom/CustomMonitoring:CustomMonitoringProps" }, "cdk-monitoring-constructs.CustomThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CustomThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/CustomAlarmFactory.ts", "line": 9 }, "name": "CustomThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/CustomAlarmFactory.ts", "line": 11 }, "name": "comparisonOperator", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.ComparisonOperator" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/CustomAlarmFactory.ts", "line": 10 }, "name": "threshold", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/CustomAlarmFactory.ts", "line": 13 }, "name": "additionalDescription", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/CustomAlarmFactory.ts", "line": 12 }, "name": "dedupeString", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/common/monitoring/alarms/CustomAlarmFactory:CustomThreshold" }, "cdk-monitoring-constructs.CustomWidget": { "assembly": "cdk-monitoring-constructs", "base": "aws-cdk-lib.aws_cloudwatch.ConcreteWidget", "docs": { "stability": "experimental", "summary": "A dashboard widget that can be customized using a Lambda." }, "fqn": "cdk-monitoring-constructs.CustomWidget", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/widget/CustomWidget.ts", "line": 66 }, "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.CustomWidgetProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/dashboard/widget/CustomWidget.ts", "line": 63 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Return the widget JSON for use in the dashboard." }, "locationInModule": { "filename": "lib/dashboard/widget/CustomWidget.ts", "line": 71 }, "name": "toJson", "overrides": "aws-cdk-lib.aws_cloudwatch.ConcreteWidget", "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "array" } } } } ], "name": "CustomWidget", "symbolId": "lib/dashboard/widget/CustomWidget:CustomWidget" }, "cdk-monitoring-constructs.CustomWidgetProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Properties of a custom widget." }, "fqn": "cdk-monitoring-constructs.CustomWidgetProps", "kind": "interface", "locationInModule": { "filename": "lib/dashboard/widget/CustomWidget.ts", "line": 7 }, "name": "CustomWidgetProps", "properties": [ { "abstract": true, "docs": { "remarks": "The Lambda function should return HTML with widget code.\nThe simplest Lambda example:\n```typescript\nexports.handler = function (event, context, callback) {\n return callback(null, \"

Hello! This is a custom widget.

\" + JSON.stringify(event, null, 2) + \"
\");\n};\n```", "stability": "experimental", "summary": "Lambda providing the widget contents." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/CustomWidget.ts", "line": 34 }, "name": "handler", "type": { "fqn": "aws-cdk-lib.aws_lambda.IFunction" } }, { "abstract": true, "docs": { "remarks": "These arguments will be available in the Lambda context.", "stability": "experimental", "summary": "Arguments to pass to the Lambda." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/CustomWidget.ts", "line": 39 }, "name": "handlerParams", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "default": "- 6", "stability": "experimental", "summary": "Height of the widget." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/CustomWidget.ts", "line": 23 }, "name": "height", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Title for the graph." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/CustomWidget.ts", "line": 11 }, "name": "title", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- true", "stability": "experimental", "summary": "Whether the widget should be updated (by calling the Lambda again) on refresh." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/CustomWidget.ts", "line": 45 }, "name": "updateOnRefresh", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- true", "stability": "experimental", "summary": "Whether the widget should be updated (by calling the Lambda again) on resize." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/CustomWidget.ts", "line": 51 }, "name": "updateOnResize", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- true", "stability": "experimental", "summary": "Whether the widget should be updated (by calling the Lambda again) on time range change." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/CustomWidget.ts", "line": 57 }, "name": "updateOnTimeRangeChange", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- 6", "stability": "experimental", "summary": "Width of the widget, in a grid of 24 units wide." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/CustomWidget.ts", "line": 17 }, "name": "width", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/dashboard/widget/CustomWidget:CustomWidgetProps" }, "cdk-monitoring-constructs.DashboardRenderingPreference": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental", "summary": "Preferred way of rendering dashboard widgets." }, "fqn": "cdk-monitoring-constructs.DashboardRenderingPreference", "kind": "enum", "locationInModule": { "filename": "lib/dashboard/DashboardRenderingPreference.ts", "line": 4 }, "members": [ { "docs": { "stability": "experimental", "summary": "Create standard set of dashboards with interactive widgets only." }, "name": "INTERACTIVE_ONLY" }, { "docs": { "stability": "experimental", "summary": "Create standard set of dashboards with bitmap widgets only." }, "name": "BITMAP_ONLY" }, { "docs": { "stability": "experimental", "summary": "Create a two sets of dashboards: standard set (interactive) and a copy (bitmap)." }, "name": "INTERACTIVE_AND_BITMAP" } ], "name": "DashboardRenderingPreference", "symbolId": "lib/dashboard/DashboardRenderingPreference:DashboardRenderingPreference" }, "cdk-monitoring-constructs.DashboardWithBitmapCopy": { "assembly": "cdk-monitoring-constructs", "base": "aws-cdk-lib.aws_cloudwatch.Dashboard", "docs": { "remarks": "The bitmap copy name will be derived from the primary dashboard name, if specified.", "stability": "experimental", "summary": "Composite dashboard which keeps a normal dashboard with its bitmap copy." }, "fqn": "cdk-monitoring-constructs.DashboardWithBitmapCopy", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/DashboardWithBitmapCopy.ts", "line": 13 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.DashboardProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/dashboard/DashboardWithBitmapCopy.ts", "line": 10 }, "methods": [ { "docs": { "remarks": "Widgets given in multiple calls to add() will be laid out stacked on\ntop of each other.\n\nMultiple widgets added in the same call to add() will be laid out next\nto each other.", "stability": "experimental", "summary": "Add a widget to the dashboard." }, "locationInModule": { "filename": "lib/dashboard/DashboardWithBitmapCopy.ts", "line": 25 }, "name": "addWidgets", "overrides": "aws-cdk-lib.aws_cloudwatch.Dashboard", "parameters": [ { "name": "widgets", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "variadic": true } ], "variadic": true } ], "name": "DashboardWithBitmapCopy", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DashboardWithBitmapCopy.ts", "line": 11 }, "name": "bitmapCopy", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.BitmapDashboard" } } ], "symbolId": "lib/dashboard/DashboardWithBitmapCopy:DashboardWithBitmapCopy" }, "cdk-monitoring-constructs.DaysSinceUpdateThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DaysSinceUpdateThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/AgeAlarmFactory.ts", "line": 21 }, "name": "DaysSinceUpdateThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/AgeAlarmFactory.ts", "line": 22 }, "name": "maxDaysSinceUpdate", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/AgeAlarmFactory:DaysSinceUpdateThreshold" }, "cdk-monitoring-constructs.DaysToExpiryThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DaysToExpiryThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/AgeAlarmFactory.ts", "line": 9 }, "name": "DaysToExpiryThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/AgeAlarmFactory.ts", "line": 10 }, "name": "minDaysToExpiry", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/AgeAlarmFactory:DaysToExpiryThreshold" }, "cdk-monitoring-constructs.DefaultAlarmAnnotationStrategy": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.FillingAlarmAnnotationStrategy", "docs": { "stability": "experimental", "summary": "Default annotation strategy that returns the built-in alarm annotation." }, "fqn": "cdk-monitoring-constructs.DefaultAlarmAnnotationStrategy", "initializer": { "docs": { "stability": "experimental" } }, "kind": "class", "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 88 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 89 }, "name": "createAnnotationToFill", "overrides": "cdk-monitoring-constructs.FillingAlarmAnnotationStrategy", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmAnnotationStrategyProps" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" } } } ], "name": "DefaultAlarmAnnotationStrategy", "symbolId": "lib/common/alarm/IAlarmAnnotationStrategy:DefaultAlarmAnnotationStrategy" }, "cdk-monitoring-constructs.DefaultDashboardFactory": { "assembly": "cdk-monitoring-constructs", "base": "constructs.Construct", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DefaultDashboardFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 97 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MonitoringDashboardsProps" } } ] }, "interfaces": [ "cdk-monitoring-constructs.IDashboardFactory", "cdk-monitoring-constructs.IDynamicDashboardFactory" ], "kind": "class", "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 84 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Adds a dynamic dashboard segment." }, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 184 }, "name": "addDynamicSegment", "overrides": "cdk-monitoring-constructs.IDynamicDashboardFactory", "parameters": [ { "name": "segment", "type": { "fqn": "cdk-monitoring-constructs.IDynamicDashboardSegment" } } ] }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 166 }, "name": "addSegment", "overrides": "cdk-monitoring-constructs.IDashboardFactory", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.IDashboardFactoryProps" } } ] }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 219 }, "name": "createdAlarmDashboard", "overrides": "cdk-monitoring-constructs.IDashboardFactory", "returns": { "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 196 }, "name": "createDashboard", "parameters": [ { "name": "renderingPreference", "type": { "fqn": "cdk-monitoring-constructs.DashboardRenderingPreference" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.DashboardProps" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 211 }, "name": "createdDashboard", "overrides": "cdk-monitoring-constructs.IDashboardFactory", "returns": { "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 215 }, "name": "createdSummaryDashboard", "overrides": "cdk-monitoring-constructs.IDashboardFactory", "returns": { "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" } } }, { "docs": { "stability": "experimental", "summary": "Gets the dashboard for the requested dashboard type." }, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 223 }, "name": "getDashboard", "overrides": "cdk-monitoring-constructs.IDynamicDashboardFactory", "parameters": [ { "name": "name", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" } } } ], "name": "DefaultDashboardFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 92 }, "name": "anyDashboardCreated", "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 95 }, "name": "dashboards", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 91 }, "name": "alarmDashboard", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 89 }, "name": "dashboard", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 90 }, "name": "summaryDashboard", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" } } ], "symbolId": "lib/dashboard/DefaultDashboardFactory:DefaultDashboardFactory" }, "cdk-monitoring-constructs.DefaultDashboards": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DefaultDashboards", "kind": "enum", "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 78 }, "members": [ { "docs": { "stability": "experimental" }, "name": "SUMMARY" }, { "docs": { "stability": "experimental" }, "name": "DETAIL" }, { "docs": { "stability": "experimental" }, "name": "ALARMS" } ], "name": "DefaultDashboards", "symbolId": "lib/dashboard/DefaultDashboardFactory:DefaultDashboards" }, "cdk-monitoring-constructs.DefaultMetricAdjuster": { "assembly": "cdk-monitoring-constructs", "docs": { "remarks": "These adjustments are always applied last, regardless the value configured in {@link AddAlarmProps.metricAdjuster}.", "stability": "experimental", "summary": "Applies the default metric adjustments." }, "fqn": "cdk-monitoring-constructs.DefaultMetricAdjuster", "initializer": { "docs": { "stability": "experimental" } }, "interfaces": [ "cdk-monitoring-constructs.IMetricAdjuster" ], "kind": "class", "locationInModule": { "filename": "lib/common/alarm/metric-adjuster/DefaultMetricAdjuster.ts", "line": 11 }, "methods": [ { "docs": { "custom": { "inheritdoc": "true" }, "stability": "experimental", "summary": "Adjusts a metric." }, "locationInModule": { "filename": "lib/common/alarm/metric-adjuster/DefaultMetricAdjuster.ts", "line": 15 }, "name": "adjustMetric", "overrides": "cdk-monitoring-constructs.IMetricAdjuster", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "_", "type": { "fqn": "constructs.Construct" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AddAlarmProps" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "DefaultMetricAdjuster", "properties": [ { "const": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/metric-adjuster/DefaultMetricAdjuster.ts", "line": 12 }, "name": "INSTANCE", "static": true, "type": { "fqn": "cdk-monitoring-constructs.DefaultMetricAdjuster" } } ], "symbolId": "lib/common/alarm/metric-adjuster/DefaultMetricAdjuster:DefaultMetricAdjuster" }, "cdk-monitoring-constructs.DefaultWidgetFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DefaultWidgetFactory", "initializer": { "docs": { "stability": "experimental" } }, "interfaces": [ "cdk-monitoring-constructs.IWidgetFactory" ], "kind": "class", "locationInModule": { "filename": "lib/dashboard/DefaultWidgetFactory.ts", "line": 10 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Create widget representing an alarm detail." }, "locationInModule": { "filename": "lib/dashboard/DefaultWidgetFactory.ts", "line": 11 }, "name": "createAlarmDetailWidget", "overrides": "cdk-monitoring-constructs.IWidgetFactory", "parameters": [ { "name": "alarm", "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" } } } ], "name": "DefaultWidgetFactory", "symbolId": "lib/dashboard/DefaultWidgetFactory:DefaultWidgetFactory" }, "cdk-monitoring-constructs.DoNotModifyDedupeString": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.ExtendDedupeString", "docs": { "stability": "experimental", "summary": "Default dedupe strategy - does not add any prefix nor suffix." }, "fqn": "cdk-monitoring-constructs.DoNotModifyDedupeString", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/IAlarmDedupeStringProcessor.ts", "line": 29 }, "parameters": [ { "name": "prefix", "optional": true, "type": { "primitive": "string" } }, { "name": "suffix", "optional": true, "type": { "primitive": "string" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/alarm/IAlarmDedupeStringProcessor.ts", "line": 46 }, "name": "DoNotModifyDedupeString", "symbolId": "lib/common/alarm/IAlarmDedupeStringProcessor:DoNotModifyDedupeString" }, "cdk-monitoring-constructs.DocumentDbAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DocumentDbAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 81 }, "name": "DocumentDbAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 82 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.DocumentDbMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:DocumentDbAspectType" }, "cdk-monitoring-constructs.DocumentDbMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DocumentDbMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 27 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.DocumentDbMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 23 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 37 }, "name": "metricAverageCpuUsageInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 41 }, "name": "metricMaxConnectionCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 49 }, "name": "metricMaxCursorCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 53 }, "name": "metricMaxTransactionOpenCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 61 }, "name": "metricOperationsThrottledDueLowMemoryCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 69 }, "name": "metricReadLatencyInMillis", "parameters": [ { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 77 }, "name": "metricWriteLatencyInMillis", "parameters": [ { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "DocumentDbMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 24 }, "name": "clusterIdentifier", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 25 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-docdb/DocumentDbMetricFactory:DocumentDbMetricFactory" }, "cdk-monitoring-constructs.DocumentDbMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DocumentDbMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 16 }, "name": "DocumentDbMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "database cluster." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 20 }, "name": "cluster", "type": { "fqn": "aws-cdk-lib.aws_docdb.IDatabaseCluster" } } ], "symbolId": "lib/monitoring/aws-docdb/DocumentDbMetricFactory:DocumentDbMetricFactoryProps" }, "cdk-monitoring-constructs.DocumentDbMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DocumentDbMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 54 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.DocumentDbMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 39 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 142 }, "name": "createConnectionsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 162 }, "name": "createLatencyWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 131 }, "name": "createResourceUsageWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 123 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 152 }, "name": "createTransactionsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 104 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 113 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "DocumentDbMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 49 }, "name": "connectionsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 46 }, "name": "cpuUsageMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 50 }, "name": "cursorsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 47 }, "name": "readLatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 52 }, "name": "throttledMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 40 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 51 }, "name": "transactionsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 43 }, "name": "usageAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.UsageAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 44 }, "name": "usageAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 48 }, "name": "writeLatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 41 }, "name": "url", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-docdb/DocumentDbMonitoring:DocumentDbMonitoring" }, "cdk-monitoring-constructs.DocumentDbMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DocumentDbMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 31 }, "name": "DocumentDbMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 32 }, "name": "addCpuUsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-docdb/DocumentDbMonitoring:DocumentDbMonitoringOptions" }, "cdk-monitoring-constructs.DocumentDbMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DocumentDbMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.DocumentDbMetricFactoryProps", "cdk-monitoring-constructs.DocumentDbMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 35 }, "name": "DocumentDbMonitoringProps", "symbolId": "lib/monitoring/aws-docdb/DocumentDbMonitoring:DocumentDbMonitoringProps" }, "cdk-monitoring-constructs.DoubleAxisGraphWidget": { "assembly": "cdk-monitoring-constructs", "base": "aws-cdk-lib.aws_cloudwatch.GraphWidget", "docs": { "remarks": "The purpose of this custom class is to make the properties more strict.\nIt will avoid graphs with undefined axes and dimensions.", "stability": "experimental", "summary": "Line graph widget with both left and right axes." }, "fqn": "cdk-monitoring-constructs.DoubleAxisGraphWidget", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 74 }, "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.DoubleAxisGraphWidgetProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 73 }, "name": "DoubleAxisGraphWidget", "symbolId": "lib/dashboard/widget/StrictGraphWidget:DoubleAxisGraphWidget" }, "cdk-monitoring-constructs.DoubleAxisGraphWidgetProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DoubleAxisGraphWidgetProps", "kind": "interface", "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 55 }, "name": "DoubleAxisGraphWidgetProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 58 }, "name": "height", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 60 }, "name": "leftAxis", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.YAxisProps" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 59 }, "name": "leftMetrics", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 63 }, "name": "rightAxis", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.YAxisProps" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 62 }, "name": "rightMetrics", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 57 }, "name": "width", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 61 }, "name": "leftAnnotations", "optional": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 64 }, "name": "rightAnnotations", "optional": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 56 }, "name": "title", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 65 }, "name": "verticalAnnotations", "optional": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.VerticalAnnotation" }, "kind": "array" } } } ], "symbolId": "lib/dashboard/widget/StrictGraphWidget:DoubleAxisGraphWidgetProps" }, "cdk-monitoring-constructs.DurationThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DurationThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/LatencyAlarmFactory.ts", "line": 144 }, "name": "DurationThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/LatencyAlarmFactory.ts", "line": 145 }, "name": "maxDuration", "type": { "fqn": "aws-cdk-lib.Duration" } } ], "symbolId": "lib/common/monitoring/alarms/LatencyAlarmFactory:DurationThreshold" }, "cdk-monitoring-constructs.DynamicDashboardConfiguration": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DynamicDashboardConfiguration", "kind": "interface", "locationInModule": { "filename": "lib/dashboard/DynamicDashboardFactory.ts", "line": 17 }, "name": "DynamicDashboardConfiguration", "properties": [ { "abstract": true, "docs": { "remarks": "NOTE: The dashboard names in {@link DefaultDashboardFactory.DefaultDashboards }\nare reserved and cannot be used as dashboard names.", "stability": "experimental", "summary": "Name of the dashboard. Full dashboard name will take the form of: `{@link MonitoringDynamicDashboardsProps.dashboardNamePrefix}-{@link name}`." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DynamicDashboardFactory.ts", "line": 25 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- respect individual graphs (PeriodOverride.INHERIT)", "stability": "experimental", "summary": "Period override for the dashboard." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DynamicDashboardFactory.ts", "line": 44 }, "name": "periodOverride", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.PeriodOverride" } }, { "abstract": true, "docs": { "default": "- 8 hours", "stability": "experimental", "summary": "Range of the dashboard." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DynamicDashboardFactory.ts", "line": 38 }, "name": "range", "optional": true, "type": { "fqn": "aws-cdk-lib.Duration" } }, { "abstract": true, "docs": { "default": "- DashboardRenderingPreference.INTERACTIVE_ONLY", "stability": "experimental", "summary": "Dashboard rendering preference." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DynamicDashboardFactory.ts", "line": 32 }, "name": "renderingPreference", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.DashboardRenderingPreference" } }, { "abstract": true, "docs": { "default": "- No variables", "stability": "experimental", "summary": "Dashboard variables to include in the dashboards." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DynamicDashboardFactory.ts", "line": 51 }, "name": "variables", "optional": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IVariable" }, "kind": "array" } } } ], "symbolId": "lib/dashboard/DynamicDashboardFactory:DynamicDashboardConfiguration" }, "cdk-monitoring-constructs.DynamicDashboardFactory": { "assembly": "cdk-monitoring-constructs", "base": "constructs.Construct", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DynamicDashboardFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/DynamicDashboardFactory.ts", "line": 73 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MonitoringDynamicDashboardsProps" } } ] }, "interfaces": [ "cdk-monitoring-constructs.IDynamicDashboardFactory" ], "kind": "class", "locationInModule": { "filename": "lib/dashboard/DynamicDashboardFactory.ts", "line": 67 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Adds a dynamic dashboard segment." }, "locationInModule": { "filename": "lib/dashboard/DynamicDashboardFactory.ts", "line": 134 }, "name": "addDynamicSegment", "overrides": "cdk-monitoring-constructs.IDynamicDashboardFactory", "parameters": [ { "name": "segment", "type": { "fqn": "cdk-monitoring-constructs.IDynamicDashboardSegment" } } ] }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/DynamicDashboardFactory.ts", "line": 119 }, "name": "createDashboard", "parameters": [ { "name": "renderingPreference", "type": { "fqn": "cdk-monitoring-constructs.DashboardRenderingPreference" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.DashboardProps" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" } } }, { "docs": { "stability": "experimental", "summary": "Gets the dashboard for the requested dashboard type." }, "locationInModule": { "filename": "lib/dashboard/DynamicDashboardFactory.ts", "line": 141 }, "name": "getDashboard", "overrides": "cdk-monitoring-constructs.IDynamicDashboardFactory", "parameters": [ { "name": "type", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" } } } ], "name": "DynamicDashboardFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DynamicDashboardFactory.ts", "line": 71 }, "name": "dashboards", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" }, "kind": "map" } } } ], "symbolId": "lib/dashboard/DynamicDashboardFactory:DynamicDashboardFactory" }, "cdk-monitoring-constructs.DynamoAlarmFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DynamoAlarmFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/DynamoAlarmFactory.ts", "line": 25 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/DynamoAlarmFactory.ts", "line": 22 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/DynamoAlarmFactory.ts", "line": 29 }, "name": "addConsumedCapacityAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "capacityType", "type": { "fqn": "cdk-monitoring-constructs.CapacityType" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.ConsumedCapacityThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/DynamoAlarmFactory.ts", "line": 51 }, "name": "addThrottledEventsAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "capacityType", "type": { "fqn": "cdk-monitoring-constructs.CapacityType" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.ThrottledEventsThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } } ], "name": "DynamoAlarmFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/DynamoAlarmFactory.ts", "line": 23 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ], "symbolId": "lib/common/monitoring/alarms/DynamoAlarmFactory:DynamoAlarmFactory" }, "cdk-monitoring-constructs.DynamoTableAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DynamoTableAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 85 }, "name": "DynamoTableAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 86 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.DynamoTableMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:DynamoTableAspectType" }, "cdk-monitoring-constructs.DynamoTableGlobalSecondaryIndexMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DynamoTableGlobalSecondaryIndexMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 23 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.DynamoTableGlobalSecondaryIndexMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 19 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 64 }, "name": "metricConsumedReadCapacityUnits", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 79 }, "name": "metricConsumedWriteCapacityUnits", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 94 }, "name": "metricIndexConsumedWriteUnitsMetric", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 36 }, "name": "metricProvisionedReadCapacityUnits", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 50 }, "name": "metricProvisionedWriteCapacityUnits", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 148 }, "name": "metricThrottledIndexRequestCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 108 }, "name": "metricThrottledReadRequestCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 128 }, "name": "metricThrottledWriteRequestCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "DynamoTableGlobalSecondaryIndexMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 21 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 20 }, "name": "table", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_dynamodb.ITable" } } ], "symbolId": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory:DynamoTableGlobalSecondaryIndexMetricFactory" }, "cdk-monitoring-constructs.DynamoTableGlobalSecondaryIndexMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DynamoTableGlobalSecondaryIndexMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 13 }, "name": "DynamoTableGlobalSecondaryIndexMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 16 }, "name": "globalSecondaryIndexName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 15 }, "name": "table", "type": { "fqn": "aws-cdk-lib.aws_dynamodb.ITable" } } ], "symbolId": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory:DynamoTableGlobalSecondaryIndexMetricFactoryProps" }, "cdk-monitoring-constructs.DynamoTableGlobalSecondaryIndexMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DynamoTableGlobalSecondaryIndexMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 58 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.DynamoTableGlobalSecondaryIndexMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 42 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 152 }, "name": "createReadCapacityWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 176 }, "name": "createThrottlesWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 144 }, "name": "createTitleWidget", "protected": true, "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 162 }, "name": "createWriteCapacityWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 126 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 135 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "DynamoTableGlobalSecondaryIndexMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 48 }, "name": "consumedReadUnitsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 49 }, "name": "consumedWriteUnitsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 55 }, "name": "gsiAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.DynamoAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 50 }, "name": "indexConsumedWriteUnitsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 53 }, "name": "indexThrottleCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 46 }, "name": "provisionedReadUnitsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 47 }, "name": "provisionedWriteUnitsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 51 }, "name": "readThrottleCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 56 }, "name": "throttledEventsAnnotations", "protected": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 43 }, "name": "title", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 52 }, "name": "writeThrottleCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 44 }, "name": "tableUrl", "optional": true, "protected": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring:DynamoTableGlobalSecondaryIndexMonitoring" }, "cdk-monitoring-constructs.DynamoTableGlobalSecondaryIndexMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DynamoTableGlobalSecondaryIndexMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.DynamoTableGlobalSecondaryIndexMetricFactoryProps", "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 29 }, "name": "DynamoTableGlobalSecondaryIndexMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 32 }, "name": "addReadThrottledEventsCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ThrottledEventsThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 36 }, "name": "addWriteThrottledEventsCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ThrottledEventsThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring:DynamoTableGlobalSecondaryIndexMonitoringProps" }, "cdk-monitoring-constructs.DynamoTableMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DynamoTableMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 33 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.DynamoTableMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 30 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 131 }, "name": "metricAverageSuccessfulRequestLatencyInMillis", "parameters": [ { "name": "operation", "type": { "fqn": "aws-cdk-lib.aws_dynamodb.Operation" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 64 }, "name": "metricConsumedReadCapacityUnits", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 78 }, "name": "metricConsumedWriteCapacityUnits", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 42 }, "name": "metricProvisionedReadCapacityUnits", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 53 }, "name": "metricProvisionedWriteCapacityUnits", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 92 }, "name": "metricReadCapacityUtilizationPercentage", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 114 }, "name": "metricSearchAverageSuccessfulRequestLatencyInMillis", "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } } }, { "docs": { "remarks": "It summarizes across the basic CRUD operations:\nGetItem, BatchGetItem, Scan, Query, GetRecords, PutItem, DeleteItem, UpdateItem, BatchWriteItem\n\nIt’s usually equal to zero.", "stability": "experimental", "summary": "This represents the number of requests that resulted in a 500 (server error) error code." }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 187 }, "name": "metricSystemErrorsCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 146 }, "name": "metricThrottledReadRequestCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 163 }, "name": "metricThrottledWriteRequestCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 224 }, "name": "metricTimeToLiveDeletedItemCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 103 }, "name": "metricWriteCapacityUtilizationPercentage", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "DynamoTableMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 31 }, "name": "table", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_dynamodb.ITable" } } ], "symbolId": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory:DynamoTableMetricFactory" }, "cdk-monitoring-constructs.DynamoTableMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DynamoTableMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 17 }, "name": "DynamoTableMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "table to monitor." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 21 }, "name": "table", "type": { "fqn": "aws-cdk-lib.aws_dynamodb.ITable" } }, { "abstract": true, "docs": { "default": "- best effort auto-detection or PROVISIONED as a fallback", "stability": "experimental", "summary": "table billing mode." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 27 }, "name": "billingMode", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_dynamodb.BillingMode" } } ], "symbolId": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory:DynamoTableMetricFactoryProps" }, "cdk-monitoring-constructs.DynamoTableMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DynamoTableMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 155 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.DynamoTableMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 121 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 445 }, "name": "createErrorsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 422 }, "name": "createLatencyWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 456 }, "name": "createReadCapacityWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 434 }, "name": "createThrottlesWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 506 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 481 }, "name": "createWriteCapacityWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 361 }, "name": "forEachOperationLatencyAlarmDefinition", "parameters": [ { "name": "operation", "type": { "fqn": "aws-cdk-lib.aws_dynamodb.Operation" } }, { "name": "alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } } ], "protected": true }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 380 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 391 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "DynamoTableMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 126 }, "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 148 }, "name": "averagePerOperationLatencyMetrics", "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 140 }, "name": "consumedReadUnitsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 141 }, "name": "consumedWriteUnitsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 129 }, "name": "dynamoCapacityAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.DynamoAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 134 }, "name": "dynamoReadCapacityAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 135 }, "name": "dynamoWriteCapacityAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 127 }, "name": "errorAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 133 }, "name": "errorCountAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 128 }, "name": "latencyAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 132 }, "name": "latencyAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 146 }, "name": "latencyAverageSearchMetrics", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 138 }, "name": "provisionedReadUnitsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 139 }, "name": "provisionedWriteUnitsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 152 }, "name": "readCapacityUsageMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 142 }, "name": "readThrottleCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 144 }, "name": "systemErrorMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 124 }, "name": "tableBillingMode", "type": { "fqn": "aws-cdk-lib.aws_dynamodb.BillingMode" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 136 }, "name": "throttledEventsAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 145 }, "name": "timeToLiveDeletedItemCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 122 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 130 }, "name": "usageAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.UsageAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 153 }, "name": "writeCapacityUsageMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 143 }, "name": "writeThrottleCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 123 }, "name": "tableUrl", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-dynamo/DynamoTableMonitoring:DynamoTableMonitoring" }, "cdk-monitoring-constructs.DynamoTableMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DynamoTableMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 54 }, "name": "DynamoTableMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 107 }, "name": "addAverageSuccessfulBatchGetItemLatencyAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 111 }, "name": "addAverageSuccessfulBatchWriteItemLatencyAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 103 }, "name": "addAverageSuccessfulDeleteItemLatencyAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 95 }, "name": "addAverageSuccessfulGetItemLatencyAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 79 }, "name": "addAverageSuccessfulGetRecordsLatencyAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 91 }, "name": "addAverageSuccessfulPutItemLatencyAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 83 }, "name": "addAverageSuccessfulQueryLatencyAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 87 }, "name": "addAverageSuccessfulScanLatencyAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 99 }, "name": "addAverageSuccessfulUpdateItemLatencyAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 55 }, "name": "addConsumedReadCapacityAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ConsumedCapacityThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 59 }, "name": "addConsumedWriteCapacityAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ConsumedCapacityThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 74 }, "name": "addMinTimeToLiveDeletedItemCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MinUsageCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 64 }, "name": "addReadThrottledEventsCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ThrottledEventsThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 73 }, "name": "addSystemErrorCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 68 }, "name": "addWriteThrottledEventsCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ThrottledEventsThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-dynamo/DynamoTableMonitoring:DynamoTableMonitoringOptions" }, "cdk-monitoring-constructs.DynamoTableMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DynamoTableMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.DynamoTableMetricFactoryProps", "cdk-monitoring-constructs.DynamoTableMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 117 }, "name": "DynamoTableMonitoringProps", "symbolId": "lib/monitoring/aws-dynamo/DynamoTableMonitoring:DynamoTableMonitoringProps" }, "cdk-monitoring-constructs.EC2AlarmFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.EC2AlarmFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/EC2AlarmFactory.ts", "line": 19 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/EC2AlarmFactory.ts", "line": 16 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/EC2AlarmFactory.ts", "line": 42 }, "name": "addNetworkInAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.NetworkInThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/EC2AlarmFactory.ts", "line": 23 }, "name": "addNetworkOutAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.NetworkOutThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } } ], "name": "EC2AlarmFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/EC2AlarmFactory.ts", "line": 17 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ], "symbolId": "lib/common/monitoring/alarms/EC2AlarmFactory:EC2AlarmFactory" }, "cdk-monitoring-constructs.EC2AspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.EC2AspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 89 }, "name": "EC2AspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 90 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.EC2MonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:EC2AspectType" }, "cdk-monitoring-constructs.EC2MetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.EC2MetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2MetricFactory.ts", "line": 170 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.EC2MetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2MetricFactory.ts", "line": 167 }, "methods": [ { "docs": { "remarks": "This metric identifies the processing power required to run an application on a selected instance.\nDepending on the instance type, tools in your operating system can show a lower percentage than\nCloudWatch when the instance is not allocated a full processor core.", "stability": "experimental", "summary": "The percentage of allocated EC2 compute units that are currently in use on the instance." }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2MetricFactory.ts", "line": 182 }, "name": "metricAverageCpuUtilisationPercent", "returns": { "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } }, "kind": "array" } } } }, { "docs": { "remarks": "This metric is used to determine the volume of the data the application reads from the hard disk of the instance.\nThis can be used to determine the speed of the application.", "stability": "experimental", "summary": "Bytes read from all instance store volumes available to the instance." }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2MetricFactory.ts", "line": 191 }, "name": "metricAverageDiskReadBytes", "returns": { "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Completed read operations from all instance store volumes available to the instance in a specified period of time." }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2MetricFactory.ts", "line": 207 }, "name": "metricAverageDiskReadOps", "returns": { "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } }, "kind": "array" } } } }, { "docs": { "remarks": "This metric is used to determine the volume of the data the application writes onto the hard disk of the instance.\nThis can be used to determine the speed of the application.", "stability": "experimental", "summary": "Bytes written to all instance store volumes available to the instance." }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2MetricFactory.ts", "line": 200 }, "name": "metricAverageDiskWriteBytes", "returns": { "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Completed write operations to all instance store volumes available to the instance in a specified period of time." }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2MetricFactory.ts", "line": 214 }, "name": "metricAverageDiskWriteOps", "returns": { "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } }, "kind": "array" } } } }, { "docs": { "remarks": "This metric identifies the volume of incoming network traffic to a single instance.", "stability": "experimental", "summary": "The number of bytes received on all network interfaces by the instance." }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2MetricFactory.ts", "line": 222 }, "name": "metricAverageNetworkInRateBytes", "returns": { "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } }, "kind": "array" } } } }, { "docs": { "remarks": "This metric identifies the volume of outgoing network traffic from a single instance.", "stability": "experimental", "summary": "The number of bytes sent out on all network interfaces by the instance." }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2MetricFactory.ts", "line": 230 }, "name": "metricAverageNetworkOutRateBytes", "returns": { "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } }, "kind": "array" } } } }, { "docs": { "remarks": "This metric identifies the volume of incoming network traffic to a single instance.", "stability": "experimental", "summary": "The number of bytes received on all network interfaces by the instance." }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2MetricFactory.ts", "line": 238 }, "name": "metricSumNetworkInRateBytes", "returns": { "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } }, "kind": "array" } } } }, { "docs": { "remarks": "This metric identifies the volume of outgoing network traffic from a single instance.", "stability": "experimental", "summary": "The number of bytes sent out on all network interfaces by the instance." }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2MetricFactory.ts", "line": 246 }, "name": "metricSumNetworkOutRateBytes", "returns": { "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } }, "kind": "array" } } } } ], "name": "EC2MetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2MetricFactory.ts", "line": 168 }, "name": "strategy", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.IEC2MetricFactoryStrategy" } } ], "symbolId": "lib/monitoring/aws-ec2/EC2MetricFactory:EC2MetricFactory" }, "cdk-monitoring-constructs.EC2MetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.EC2MetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2MetricFactory.ts", "line": 154 }, "name": "EC2MetricFactoryProps", "properties": [ { "abstract": true, "docs": { "default": "- no Auto-Scaling Group filter", "stability": "experimental", "summary": "Auto-Scaling Group to monitor." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2MetricFactory.ts", "line": 159 }, "name": "autoScalingGroup", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_autoscaling.IAutoScalingGroup" } }, { "abstract": true, "docs": { "default": "- no instance filter", "stability": "experimental", "summary": "Selected IDs of EC2 instances to monitor." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2MetricFactory.ts", "line": 164 }, "name": "instanceIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/monitoring/aws-ec2/EC2MetricFactory:EC2MetricFactoryProps" }, "cdk-monitoring-constructs.EC2Monitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.EC2Monitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 68 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.EC2MonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 48 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 192 }, "name": "createCpuWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 212 }, "name": "createDiskOpsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 202 }, "name": "createDiskWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 222 }, "name": "createNetworkWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 185 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 157 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 170 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "EC2Monitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 54 }, "name": "cpuUtilisationMetrics", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 55 }, "name": "diskReadBytesMetrics", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 57 }, "name": "diskReadOpsMetrics", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 56 }, "name": "diskWriteBytesMetrics", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 58 }, "name": "diskWriteOpsMetrics", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 52 }, "name": "ec2AlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.EC2AlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 49 }, "name": "family", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 59 }, "name": "networkInMetrics", "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 65 }, "name": "networkInSumLimitAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 62 }, "name": "networkInSumMetrics", "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 60 }, "name": "networkOutMetrics", "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 66 }, "name": "networkOutSumLimitAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 63 }, "name": "networkOutSumMetrics", "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 50 }, "name": "title", "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-ec2/EC2Monitoring:EC2Monitoring" }, "cdk-monitoring-constructs.EC2MonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.EC2MonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.EC2MetricFactoryProps", "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 32 }, "name": "EC2MonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 40 }, "name": "addNetworkInTotalBytesExceedThresholdAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.NetworkInThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 35 }, "name": "addNetworkOutTotalBytesExceedThresholdAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.NetworkOutThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-ec2/EC2Monitoring:EC2MonitoringOptions" }, "cdk-monitoring-constructs.EC2MonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.EC2MonitoringProps", "interfaces": [ "cdk-monitoring-constructs.EC2MonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 46 }, "name": "EC2MonitoringProps", "symbolId": "lib/monitoring/aws-ec2/EC2Monitoring:EC2MonitoringProps" }, "cdk-monitoring-constructs.Ec2ApplicationLoadBalancerMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Monitoring props for EC2 service with application load balancer and plain service." }, "fqn": "cdk-monitoring-constructs.Ec2ApplicationLoadBalancerMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.ApplicationLoadBalancerMetricFactoryProps", "cdk-monitoring-constructs.BaseMonitoringProps", "cdk-monitoring-constructs.BaseEc2ServiceAlarms" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 151 }, "name": "Ec2ApplicationLoadBalancerMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 154 }, "name": "ec2Service", "type": { "fqn": "aws-cdk-lib.aws_ecs.Ec2Service" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 101 }, "name": "addHealthyTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.HealthyTaskCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 106 }, "name": "addHealthyTaskPercentAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.HealthyTaskPercentThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 110 }, "name": "addMinProcessedBytesAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MinProcessedBytesThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 102 }, "name": "addUnhealthyTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UnhealthyTaskCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "false", "remarks": "When `invertLoadBalancerTaskCountMetricsStatistics` is set to false, the minimum of `HealthyHostCount` and the maximum of `UnHealthyHostCount` are monitored.\nWhen `invertLoadBalancerTaskCountMetricsStatistics` is set to true, the maximum of `HealthyHostCount` and the minimum of `UnHealthyHostCount` are monitored.\n\n`invertLoadBalancerTaskCountMetricsStatistics` is recommended to set to true as per the guidelines at\nhttps://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-cloudwatch-metrics.html#metric-statistics", "stability": "experimental", "summary": "Invert the statistics of `HealthyHostCount` and `UnHealthyHostCount`." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 126 }, "name": "invertLoadBalancerTaskCountMetricsStatistics", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring:Ec2ApplicationLoadBalancerMonitoringProps" }, "cdk-monitoring-constructs.Ec2NetworkLoadBalancerMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Monitoring props for EC2 service with network load balancer and plain service." }, "fqn": "cdk-monitoring-constructs.Ec2NetworkLoadBalancerMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.NetworkLoadBalancerMetricFactoryProps", "cdk-monitoring-constructs.BaseMonitoringProps", "cdk-monitoring-constructs.BaseEc2ServiceAlarms" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 142 }, "name": "Ec2NetworkLoadBalancerMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 145 }, "name": "ec2Service", "type": { "fqn": "aws-cdk-lib.aws_ecs.Ec2Service" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 101 }, "name": "addHealthyTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.HealthyTaskCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 106 }, "name": "addHealthyTaskPercentAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.HealthyTaskPercentThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 110 }, "name": "addMinProcessedBytesAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MinProcessedBytesThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 102 }, "name": "addUnhealthyTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UnhealthyTaskCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "false", "remarks": "When `invertLoadBalancerTaskCountMetricsStatistics` is set to false, the minimum of `HealthyHostCount` and the maximum of `UnHealthyHostCount` are monitored.\nWhen `invertLoadBalancerTaskCountMetricsStatistics` is set to true, the maximum of `HealthyHostCount` and the minimum of `UnHealthyHostCount` are monitored.\n\n`invertLoadBalancerTaskCountMetricsStatistics` is recommended to set to true as per the guidelines at\nhttps://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-cloudwatch-metrics.html#metric-statistics", "stability": "experimental", "summary": "Invert the statistics of `HealthyHostCount` and `UnHealthyHostCount`." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 126 }, "name": "invertLoadBalancerTaskCountMetricsStatistics", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring:Ec2NetworkLoadBalancerMonitoringProps" }, "cdk-monitoring-constructs.Ec2ServiceMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.Ec2ServiceMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 195 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.CustomEc2ServiceMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 164 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 438 }, "name": "createCpuWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 449 }, "name": "createMemoryWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 460 }, "name": "createTaskHealthWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 481 }, "name": "createTcpFlowsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 431 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "deprecated": "use {@see createTcpFlowsWidget} instead.", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 515 }, "name": "createTpcFlowsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 397 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 406 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "Ec2ServiceMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 168 }, "name": "baseServiceMetricFactory", "type": { "fqn": "cdk-monitoring-constructs.BaseServiceMetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 183 }, "name": "cpuP100UtilisationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 175 }, "name": "cpuUsageAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 182 }, "name": "cpuUtilisationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 187 }, "name": "ephemeralStorageUsageMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 185 }, "name": "memoryP100UtilisationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 176 }, "name": "memoryUsageAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 184 }, "name": "memoryUtilisationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 167 }, "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 177 }, "name": "processedBytesAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 186 }, "name": "runningTaskCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 171 }, "name": "taskHealthAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.TaskHealthAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 173 }, "name": "taskHealthAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 172 }, "name": "throughputAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.ThroughputAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 165 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 174 }, "name": "usageAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.UsageAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 188 }, "name": "activeTcpFlowCountMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 179 }, "name": "healthyTaskCountMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 181 }, "name": "healthyTaskPercentMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 169 }, "name": "loadBalancerMetricFactory", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.ILoadBalancerMetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 189 }, "name": "newTcpFlowCountMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 191 }, "name": "processedBytesMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 190 }, "name": "unhealthyRoutingFlowCountMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 180 }, "name": "unhealthyTaskCountMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } ], "symbolId": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring:Ec2ServiceMonitoring" }, "cdk-monitoring-constructs.Ec2ServiceMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Monitoring props for load-balanced EC2 service." }, "fqn": "cdk-monitoring-constructs.Ec2ServiceMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps", "cdk-monitoring-constructs.BaseEc2ServiceAlarms" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 132 }, "name": "Ec2ServiceMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 134 }, "name": "ec2Service", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_ecs_patterns.NetworkLoadBalancedEc2Service" }, { "fqn": "aws-cdk-lib.aws_ecs_patterns.ApplicationLoadBalancedEc2Service" } ] } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 101 }, "name": "addHealthyTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.HealthyTaskCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 106 }, "name": "addHealthyTaskPercentAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.HealthyTaskPercentThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 110 }, "name": "addMinProcessedBytesAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MinProcessedBytesThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 102 }, "name": "addUnhealthyTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UnhealthyTaskCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "false", "remarks": "When `invertLoadBalancerTaskCountMetricsStatistics` is set to false, the minimum of `HealthyHostCount` and the maximum of `UnHealthyHostCount` are monitored.\nWhen `invertLoadBalancerTaskCountMetricsStatistics` is set to true, the maximum of `HealthyHostCount` and the minimum of `UnHealthyHostCount` are monitored.\n\n`invertLoadBalancerTaskCountMetricsStatistics` is recommended to set to true as per the guidelines at\nhttps://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-cloudwatch-metrics.html#metric-statistics", "stability": "experimental", "summary": "Invert the statistics of `HealthyHostCount` and `UnHealthyHostCount`." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 126 }, "name": "invertLoadBalancerTaskCountMetricsStatistics", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring:Ec2ServiceMonitoringProps" }, "cdk-monitoring-constructs.ElastiCacheAlarmFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ElastiCacheAlarmFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory.ts", "line": 32 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory.ts", "line": 29 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory.ts", "line": 55 }, "name": "addMaxEvictedItemsCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MaxItemsCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory.ts", "line": 36 }, "name": "addMaxItemsCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MaxItemsCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory.ts", "line": 131 }, "name": "addMaxThrottleRateAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MaxThrottleRateThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory.ts", "line": 93 }, "name": "addMaxUsedSwapMemoryAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MaxUsedSwapMemoryThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory.ts", "line": 74 }, "name": "addMinFreeableMemoryAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MinFreeableMemoryThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory.ts", "line": 112 }, "name": "addMinHitRateAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MinHitRateThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } } ], "name": "ElastiCacheAlarmFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory.ts", "line": 30 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ], "symbolId": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory:ElastiCacheAlarmFactory" }, "cdk-monitoring-constructs.ElastiCacheAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ElastiCacheAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 93 }, "name": "ElastiCacheAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 94 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.ElastiCacheClusterMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:ElastiCacheAspectType" }, "cdk-monitoring-constructs.ElastiCacheClusterMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "see": "https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/CacheMetrics.html", "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ElastiCacheClusterMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 32 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.ElastiCacheClusterMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 29 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 100 }, "name": "metricAverageCachedItemsSizeInBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 164 }, "name": "metricAverageConnections", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 72 }, "name": "metricAverageFreeableMemoryInBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 114 }, "name": "metricAverageSwapUsageInBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 86 }, "name": "metricAverageUnusedMemoryInBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 58 }, "name": "metricEvictions", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 128 }, "name": "metricMaxCpuUtilizationInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 44 }, "name": "metricMaxItemCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "remarks": "Note that you may want to monitor both Engine CPU Utilization as well as CPU Utilization as background\nprocesses can take up a significant portion of the CPU workload. This is especially important for\nhosts with 2 vCPUs or less.", "see": "https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheMetrics.Redis.html", "stability": "experimental", "summary": "Because Redis is single-threaded, you can use this metric to analyze the load of the Redis process itself." }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 150 }, "name": "metricMaxRedisEngineCpuUtilizationInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 178 }, "name": "metricNetworkBytesIn", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 192 }, "name": "metricNetworkBytesOut", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "ElastiCacheClusterMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 30 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory:ElastiCacheClusterMetricFactory" }, "cdk-monitoring-constructs.ElastiCacheClusterMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ElastiCacheClusterMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 17 }, "name": "ElastiCacheClusterMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "default": "- monitor all clusters", "stability": "experimental", "summary": "Cluster to monitor." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 23 }, "name": "clusterId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory:ElastiCacheClusterMetricFactoryProps" }, "cdk-monitoring-constructs.ElastiCacheClusterMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ElastiCacheClusterMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 114 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.ElastiCacheClusterMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 91 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 345 }, "name": "createConnectionsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 294 }, "name": "createCpuUsageWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 331 }, "name": "createItemCountWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 316 }, "name": "createMemoryUsageWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 305 }, "name": "createRedisEngineCpuUsageWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 286 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 248 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 257 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "ElastiCacheClusterMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 94 }, "name": "clusterType", "type": { "fqn": "cdk-monitoring-constructs.ElastiCacheClusterType" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 96 }, "name": "connectionsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 108 }, "name": "cpuUsageAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 97 }, "name": "cpuUsageMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 107 }, "name": "elastiCacheAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.ElastiCacheAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 111 }, "name": "evictedItemsCountAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 99 }, "name": "freeableMemoryMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 110 }, "name": "itemsCountAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 103 }, "name": "itemsCountMetrics", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 104 }, "name": "itemsEvictedMetrics", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 102 }, "name": "itemsMemoryMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 112 }, "name": "memoryUsageAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 109 }, "name": "redisEngineCpuUsageAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 98 }, "name": "redisEngineCpuUsageMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 101 }, "name": "swapMemoryMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 92 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 100 }, "name": "unusedMemoryMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 106 }, "name": "usageAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.UsageAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 93 }, "name": "clusterUrl", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring:ElastiCacheClusterMonitoring" }, "cdk-monitoring-constructs.ElastiCacheClusterMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ElastiCacheClusterMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 39 }, "name": "ElastiCacheClusterMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Cluster type (needed, since each type has their own specific metrics)." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 44 }, "name": "clusterType", "type": { "fqn": "cdk-monitoring-constructs.ElastiCacheClusterType" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Add CPU usage alarm (useful for all clusterTypes including Redis)." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 49 }, "name": "addCpuUsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Add alarm on number of evicted items." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 66 }, "name": "addMaxEvictedItemsCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MaxItemsCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Add alarm on total number of items." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 62 }, "name": "addMaxItemsCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MaxItemsCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Add alarm on amount of used swap memory." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 81 }, "name": "addMaxUsedSwapMemoryAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MaxUsedSwapMemoryThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Add alarm on amount of freeable memory." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 74 }, "name": "addMinFreeableMemoryAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MinFreeableMemoryThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "remarks": "It is recommended to monitor CPU utilization with `addCpuUsageAlarm`\nas well for hosts with two vCPUs or less.", "stability": "experimental", "summary": "Add Redis engine CPU usage alarm." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 57 }, "name": "addRedisEngineCpuUsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring:ElastiCacheClusterMonitoringOptions" }, "cdk-monitoring-constructs.ElastiCacheClusterMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ElastiCacheClusterMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.ElastiCacheClusterMetricFactoryProps", "cdk-monitoring-constructs.ElastiCacheClusterMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 87 }, "name": "ElastiCacheClusterMonitoringProps", "symbolId": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring:ElastiCacheClusterMonitoringProps" }, "cdk-monitoring-constructs.ElastiCacheClusterType": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ElastiCacheClusterType", "kind": "enum", "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 12 }, "members": [ { "docs": { "stability": "experimental" }, "name": "MEMCACHED" }, { "docs": { "stability": "experimental" }, "name": "REDIS" } ], "name": "ElastiCacheClusterType", "symbolId": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory:ElastiCacheClusterType" }, "cdk-monitoring-constructs.ElastiCacheServerlessMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "see": "https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/serverless-metrics-events-redis.html", "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ElastiCacheServerlessMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMetricFactory.ts", "line": 29 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.ElastiCacheServerlessMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMetricFactory.ts", "line": 26 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMetricFactory.ts", "line": 206 }, "name": "metricAverageCacheHitRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMetricFactory.ts", "line": 69 }, "name": "metricAverageCacheSize", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMetricFactory.ts", "line": 97 }, "name": "metricAverageConnections", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMetricFactory.ts", "line": 220 }, "name": "metricCacheHits", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMetricFactory.ts", "line": 234 }, "name": "metricCacheMisses", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMetricFactory.ts", "line": 55 }, "name": "metricEvictions", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMetricFactory.ts", "line": 83 }, "name": "metricMaxElastiCacheProcessingUnits", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMetricFactory.ts", "line": 41 }, "name": "metricMaxItemCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMetricFactory.ts", "line": 111 }, "name": "metricNetworkBytesIn", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMetricFactory.ts", "line": 125 }, "name": "metricNetworkBytesOut", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMetricFactory.ts", "line": 139 }, "name": "metricSuccessfulReadRequestLatency", "parameters": [ { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMetricFactory.ts", "line": 153 }, "name": "metricSuccessfulWriteRequestLatency", "parameters": [ { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMetricFactory.ts", "line": 195 }, "name": "metricThrottleRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMetricFactory.ts", "line": 181 }, "name": "metricTotalCmds", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMetricFactory.ts", "line": 167 }, "name": "metricTotalThrottledCmds", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "ElastiCacheServerlessMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMetricFactory.ts", "line": 27 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMetricFactory:ElastiCacheServerlessMetricFactory" }, "cdk-monitoring-constructs.ElastiCacheServerlessMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ElastiCacheServerlessMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMetricFactory.ts", "line": 14 }, "name": "ElastiCacheServerlessMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "default": "- monitor all clusters", "stability": "experimental", "summary": "Cluster to monitor." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMetricFactory.ts", "line": 20 }, "name": "clusterId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMetricFactory:ElastiCacheServerlessMetricFactoryProps" }, "cdk-monitoring-constructs.ElastiCacheServerlessMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ElastiCacheServerlessMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 148 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.ElastiCacheServerlessMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 117 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 403 }, "name": "createCacheCmdsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 390 }, "name": "createCacheHitAndMissWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 380 }, "name": "createCacheSizeWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 448 }, "name": "createConnectionsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 436 }, "name": "createItemCountWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 416 }, "name": "createNetworkWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 426 }, "name": "createProcessingUnitsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 346 }, "name": "createSuccessfulReadLatencyWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 363 }, "name": "createSuccessfulWriteLatencyWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 339 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 290 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 307 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "ElastiCacheServerlessMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 142 }, "name": "averageSuccessfulReadRequestLatencyAlarmAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 144 }, "name": "averageSuccessfulWriteRequestLatencyAlarmAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 138 }, "name": "elastiCacheAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.ElastiCacheAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 146 }, "name": "hitRateAlarmAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 139 }, "name": "latencyAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 134 }, "name": "metricAverageCacheHitRate", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 122 }, "name": "metricAverageCacheSize", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 124 }, "name": "metricAverageConnections", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 128 }, "name": "metricAverageSuccessfulReadRequestLatency", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 130 }, "name": "metricAverageSuccessfulWriteRequestLatency", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 135 }, "name": "metricCacheHits", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 136 }, "name": "metricCacheMisses", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 121 }, "name": "metricEvictions", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 123 }, "name": "metricMaxElastiCacheProcessingUnits", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 120 }, "name": "metricMaxItemCount", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 125 }, "name": "metricNetworkBytesIn", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 126 }, "name": "metricNetworkBytesOut", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 133 }, "name": "metricThrottleRate", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 127 }, "name": "metricTM99SuccessfulReadRequestLatency", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 129 }, "name": "metricTM99SuccessfulWriteRequestLatency", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 132 }, "name": "metricTotalCmds", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 131 }, "name": "metricTotalThrottledCmds", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 145 }, "name": "throttleRateAlarmAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 118 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 141 }, "name": "tm99SuccessfulReadRequestLatencyAlarmAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 143 }, "name": "tm99SuccessfulWriteRequestLatencyAlarmAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } } ], "symbolId": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring:ElastiCacheServerlessMonitoring" }, "cdk-monitoring-constructs.ElastiCacheServerlessMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "remarks": "Extends BaseMonitoringProps to include alarm configurations specific to\nElastiCache Serverless metrics such as latency, throttling, cache hit rates,\nand item counts.", "stability": "experimental", "summary": "Configuration options for monitoring ElastiCache Serverless clusters." }, "fqn": "cdk-monitoring-constructs.ElastiCacheServerlessMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 44 }, "name": "ElastiCacheServerlessMonitoringOptions", "properties": [ { "abstract": true, "docs": { "default": "- no alarm", "remarks": "The key is a disambiguator (e.g., \"Warning\", \"Critical\") and the value defines the latency threshold.", "stability": "experimental", "summary": "Add alarm when the average latency for successful read requests exceeds a threshold." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 65 }, "name": "addAverageSuccessfulReadRequestLatencyAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- no alarm", "remarks": "The key is a disambiguator (e.g., \"Warning\", \"Critical\") and the value defines the latency threshold.", "stability": "experimental", "summary": "Add alarm when the average latency for successful write requests exceeds a threshold." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 89 }, "name": "addAverageSuccessfulWriteRequestLatencyAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- no alarm", "remarks": "The key is a disambiguator (e.g., \"Warning\", \"Critical\") and the value defines the minimum hit rate threshold.", "stability": "experimental", "summary": "Add alarm when the cache hit rate falls below a minimum threshold." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 110 }, "name": "addHitRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MinHitRateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- no alarm", "remarks": "The key is a disambiguator (e.g., \"Warning\", \"Critical\") and the value defines the usage threshold.", "stability": "experimental", "summary": "Add alarm when the throttle rate (percentage of throttled commands) exceeds a threshold." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 101 }, "name": "addThrottleRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MaxThrottleRateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- no alarm", "remarks": "The key is a disambiguator (e.g., \"Warning\", \"Critical\") and the value defines the latency threshold.", "stability": "experimental", "summary": "Add alarm when the 99th percentile (TM99) latency for successful read requests exceeds a threshold." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 53 }, "name": "addTM99SuccessfulReadRequestLatencyAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- no alarm", "remarks": "The key is a disambiguator (e.g., \"Warning\", \"Critical\") and the value defines the latency threshold.", "stability": "experimental", "summary": "Add alarm when the 99th percentile (TM99) latency for successful write requests exceeds a threshold." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 77 }, "name": "addTM99SuccessfulWriteRequestLatencyAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring:ElastiCacheServerlessMonitoringOptions" }, "cdk-monitoring-constructs.ElastiCacheServerlessMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ElastiCacheServerlessMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.ElastiCacheServerlessMetricFactoryProps", "cdk-monitoring-constructs.ElastiCacheServerlessMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring.ts", "line": 113 }, "name": "ElastiCacheServerlessMonitoringProps", "symbolId": "lib/monitoring/aws-elasticache/ElastiCacheServerlessMonitoring:ElastiCacheServerlessMonitoringProps" }, "cdk-monitoring-constructs.ElasticsearchClusterStatus": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ElasticsearchClusterStatus", "kind": "enum", "locationInModule": { "filename": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory.ts", "line": 14 }, "members": [ { "docs": { "stability": "experimental" }, "name": "RED" }, { "docs": { "stability": "experimental" }, "name": "YELLOW" } ], "name": "ElasticsearchClusterStatus", "symbolId": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory:ElasticsearchClusterStatus" }, "cdk-monitoring-constructs.ErrorAlarmFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/ErrorAlarmFactory.ts", "line": 36 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/ErrorAlarmFactory.ts", "line": 33 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/ErrorAlarmFactory.ts", "line": 40 }, "name": "addErrorCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "errorType", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/ErrorAlarmFactory.ts", "line": 66 }, "name": "addErrorRateAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "errorType", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } } ], "name": "ErrorAlarmFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/ErrorAlarmFactory.ts", "line": 34 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ], "symbolId": "lib/common/monitoring/alarms/ErrorAlarmFactory:ErrorAlarmFactory" }, "cdk-monitoring-constructs.ErrorCountThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ErrorCountThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/ErrorAlarmFactory.ts", "line": 25 }, "name": "ErrorCountThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/ErrorAlarmFactory.ts", "line": 26 }, "name": "maxErrorCount", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/ErrorAlarmFactory:ErrorCountThreshold" }, "cdk-monitoring-constructs.ErrorRateThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ErrorRateThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/ErrorAlarmFactory.ts", "line": 29 }, "name": "ErrorRateThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/ErrorAlarmFactory.ts", "line": 30 }, "name": "maxErrorRate", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/ErrorAlarmFactory:ErrorRateThreshold" }, "cdk-monitoring-constructs.ErrorType": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ErrorType", "kind": "enum", "locationInModule": { "filename": "lib/common/monitoring/alarms/ErrorAlarmFactory.ts", "line": 9 }, "members": [ { "docs": { "stability": "experimental" }, "name": "FAULT" }, { "docs": { "stability": "experimental" }, "name": "ERROR" }, { "docs": { "stability": "experimental" }, "name": "SYSTEM_ERROR" }, { "docs": { "stability": "experimental" }, "name": "USER_ERROR" }, { "docs": { "stability": "experimental" }, "name": "FAILURE" }, { "docs": { "stability": "experimental" }, "name": "ABORTED" }, { "docs": { "stability": "experimental" }, "name": "THROTTLED" }, { "docs": { "stability": "experimental" }, "name": "TIMED_OUT" }, { "docs": { "stability": "experimental" }, "name": "READ_ERROR" }, { "docs": { "stability": "experimental" }, "name": "WRITE_ERROR" }, { "docs": { "stability": "experimental" }, "name": "EXPIRED" }, { "docs": { "stability": "experimental" }, "name": "KILLED" }, { "docs": { "stability": "experimental" }, "name": "BLOCKED" } ], "name": "ErrorType", "symbolId": "lib/common/monitoring/alarms/ErrorAlarmFactory:ErrorType" }, "cdk-monitoring-constructs.ExtendDedupeString": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental", "summary": "Dedupe string processor that adds prefix and/or suffix to the dedupe string." }, "fqn": "cdk-monitoring-constructs.ExtendDedupeString", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/IAlarmDedupeStringProcessor.ts", "line": 29 }, "parameters": [ { "name": "prefix", "optional": true, "type": { "primitive": "string" } }, { "name": "suffix", "optional": true, "type": { "primitive": "string" } } ] }, "interfaces": [ "cdk-monitoring-constructs.IAlarmDedupeStringProcessor" ], "kind": "class", "locationInModule": { "filename": "lib/common/alarm/IAlarmDedupeStringProcessor.ts", "line": 25 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Process the dedupe string which was auto-generated." }, "locationInModule": { "filename": "lib/common/alarm/IAlarmDedupeStringProcessor.ts", "line": 34 }, "name": "processDedupeString", "overrides": "cdk-monitoring-constructs.IAlarmDedupeStringProcessor", "parameters": [ { "name": "dedupeString", "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental", "summary": "Process the dedupe string which was specified by the user as an override." }, "locationInModule": { "filename": "lib/common/alarm/IAlarmDedupeStringProcessor.ts", "line": 38 }, "name": "processDedupeStringOverride", "overrides": "cdk-monitoring-constructs.IAlarmDedupeStringProcessor", "parameters": [ { "name": "dedupeString", "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } } } ], "name": "ExtendDedupeString", "symbolId": "lib/common/alarm/IAlarmDedupeStringProcessor:ExtendDedupeString" }, "cdk-monitoring-constructs.FargateApplicationLoadBalancerMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Monitoring props for Fargate service with application load balancer and plain service." }, "fqn": "cdk-monitoring-constructs.FargateApplicationLoadBalancerMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.ApplicationLoadBalancerMetricFactoryProps", "cdk-monitoring-constructs.BaseLoadBalancedFargateServiceMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 151 }, "name": "FargateApplicationLoadBalancerMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 154 }, "name": "fargateService", "type": { "fqn": "aws-cdk-lib.aws_ecs.FargateService" } } ], "symbolId": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring:FargateApplicationLoadBalancerMonitoringProps" }, "cdk-monitoring-constructs.FargateNetworkLoadBalancerMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Monitoring props for Fargate service with network load balancer and plain service." }, "fqn": "cdk-monitoring-constructs.FargateNetworkLoadBalancerMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.NetworkLoadBalancerMetricFactoryProps", "cdk-monitoring-constructs.BaseLoadBalancedFargateServiceMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 142 }, "name": "FargateNetworkLoadBalancerMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 145 }, "name": "fargateService", "type": { "fqn": "aws-cdk-lib.aws_ecs.FargateService" } } ], "symbolId": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring:FargateNetworkLoadBalancerMonitoringProps" }, "cdk-monitoring-constructs.FargateServiceAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.FargateServiceAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 97 }, "name": "FargateServiceAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 98 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.BaseFargateServiceMonitoringProps" } } ], "symbolId": "lib/facade/IMonitoringAspect:FargateServiceAspectType" }, "cdk-monitoring-constructs.FargateServiceMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.FargateServiceMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 195 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.CustomFargateServiceMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 164 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 442 }, "name": "createCpuWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 453 }, "name": "createMemoryWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 464 }, "name": "createTaskHealthWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 485 }, "name": "createTcpFlowsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 435 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "deprecated": "use {@see createTcpFlowsWidget} instead.", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 519 }, "name": "createTpcFlowsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 401 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 410 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "FargateServiceMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 168 }, "name": "baseServiceMetricFactory", "type": { "fqn": "cdk-monitoring-constructs.BaseServiceMetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 183 }, "name": "cpuP100UtilisationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 175 }, "name": "cpuUsageAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 182 }, "name": "cpuUtilisationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 187 }, "name": "ephemeralStorageUsageMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 185 }, "name": "memoryP100UtilisationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 176 }, "name": "memoryUsageAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 184 }, "name": "memoryUtilisationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 167 }, "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 177 }, "name": "processedBytesAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 186 }, "name": "runningTaskCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 171 }, "name": "taskHealthAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.TaskHealthAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 173 }, "name": "taskHealthAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 172 }, "name": "throughputAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.ThroughputAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 165 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 174 }, "name": "usageAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.UsageAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 188 }, "name": "activeTcpFlowCountMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 179 }, "name": "healthyTaskCountMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 181 }, "name": "healthyTaskPercentMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 169 }, "name": "loadBalancerMetricFactory", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.ILoadBalancerMetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 189 }, "name": "newTcpFlowCountMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 191 }, "name": "processedBytesMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 190 }, "name": "unhealthyRoutingFlowCountMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 180 }, "name": "unhealthyTaskCountMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } ], "symbolId": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring:FargateServiceMonitoring" }, "cdk-monitoring-constructs.FargateServiceMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Monitoring props for load-balanced Fargate service." }, "fqn": "cdk-monitoring-constructs.FargateServiceMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.BaseLoadBalancedFargateServiceMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 132 }, "name": "FargateServiceMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 134 }, "name": "fargateService", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_ecs_patterns.NetworkLoadBalancedFargateService" }, { "fqn": "aws-cdk-lib.aws_ecs_patterns.ApplicationLoadBalancedFargateService" } ] } } } ], "symbolId": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring:FargateServiceMonitoringProps" }, "cdk-monitoring-constructs.FillingAlarmAnnotationStrategy": { "abstract": true, "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental", "summary": "Annotation strategy that fills the annotation provided, using the input and user requirements." }, "fqn": "cdk-monitoring-constructs.FillingAlarmAnnotationStrategy", "initializer": { "docs": { "stability": "experimental" } }, "interfaces": [ "cdk-monitoring-constructs.IAlarmAnnotationStrategy" ], "kind": "class", "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 40 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Creates annotation based on the metric and alarm properties." }, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 43 }, "name": "createAnnotation", "overrides": "cdk-monitoring-constructs.IAlarmAnnotationStrategy", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmAnnotationStrategyProps" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 61 }, "name": "createAnnotationToFill", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmAnnotationStrategyProps" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 65 }, "name": "getAlarmingRangeShade", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmAnnotationStrategyProps" } } ], "protected": true, "returns": { "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Shading" } } } ], "name": "FillingAlarmAnnotationStrategy", "symbolId": "lib/common/alarm/IAlarmAnnotationStrategy:FillingAlarmAnnotationStrategy" }, "cdk-monitoring-constructs.FirehoseStreamLimitThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.FirehoseStreamLimitThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 17 }, "name": "FirehoseStreamLimitThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Threshold value between [0.0, 1.0) for when the alarm should be triggered." }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 21 }, "name": "safetyThresholdLimit", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/KinesisAlarmFactory:FirehoseStreamLimitThreshold" }, "cdk-monitoring-constructs.FluentBitFilterMetricTag": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.FluentBitFilterMetricTag", "kind": "enum", "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitConstants.ts", "line": 19 }, "members": [ { "docs": { "stability": "experimental" }, "name": "FILTER_EMIT_RECORDS" }, { "docs": { "stability": "experimental" }, "name": "FILTER_DROP_RECORDS" }, { "docs": { "stability": "experimental" }, "name": "FILTER_ADD_RECORDS" } ], "name": "FluentBitFilterMetricTag", "symbolId": "lib/monitoring/fluentbit/FluentBitConstants:FluentBitFilterMetricTag" }, "cdk-monitoring-constructs.FluentBitInputMetricTag": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.FluentBitInputMetricTag", "kind": "enum", "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitConstants.ts", "line": 16 }, "members": [ { "docs": { "stability": "experimental" }, "name": "INPUT_RECORDS" } ], "name": "FluentBitInputMetricTag", "symbolId": "lib/monitoring/fluentbit/FluentBitConstants:FluentBitInputMetricTag" }, "cdk-monitoring-constructs.FluentBitMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.FluentBitMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMetricFactory.ts", "line": 28 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.FluentBitMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMetricFactory.ts", "line": 24 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMetricFactory.ts", "line": 37 }, "name": "filterMetrics", "parameters": [ { "name": "logGroup", "type": { "fqn": "aws-cdk-lib.aws_logs.ILogGroup" } } ], "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, "kind": "array" } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMetricFactory.ts", "line": 49 }, "name": "inputMetrics", "parameters": [ { "name": "logGroup", "type": { "fqn": "aws-cdk-lib.aws_logs.ILogGroup" } } ], "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, "kind": "array" } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMetricFactory.ts", "line": 96 }, "name": "metricsWithoutWidgets", "parameters": [ { "name": "logGroup", "type": { "fqn": "aws-cdk-lib.aws_logs.ILogGroup" } } ] }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMetricFactory.ts", "line": 43 }, "name": "outputMetrics", "parameters": [ { "name": "logGroup", "type": { "fqn": "aws-cdk-lib.aws_logs.ILogGroup" } } ], "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, "kind": "array" } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMetricFactory.ts", "line": 74 }, "name": "storageMetrics", "parameters": [ { "name": "logGroup", "type": { "fqn": "aws-cdk-lib.aws_logs.ILogGroup" } } ], "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, "kind": "array" } } } } ], "name": "FluentBitMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMetricFactory.ts", "line": 25 }, "name": "namespace", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMetricFactory.ts", "line": 26 }, "name": "scope", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } } ], "symbolId": "lib/monitoring/fluentbit/FluentBitMetricFactory:FluentBitMetricFactory" }, "cdk-monitoring-constructs.FluentBitMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.FluentBitMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMetricFactory.ts", "line": 16 }, "name": "FluentBitMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "default": "metric factory default", "stability": "experimental", "summary": "Namespace that metrics will be emitted to." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMetricFactory.ts", "line": 21 }, "name": "namespace", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/fluentbit/FluentBitMetricFactory:FluentBitMetricFactoryProps" }, "cdk-monitoring-constructs.FluentBitMetricsWithoutWidget": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.FluentBitMetricsWithoutWidget", "kind": "enum", "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitConstants.ts", "line": 25 }, "members": [ { "docs": { "stability": "experimental" }, "name": "INPUT_BYTES" }, { "docs": { "stability": "experimental" }, "name": "OUTPUT_PROC_RECORDS" }, { "docs": { "stability": "experimental" }, "name": "OUTPUT_PROC_BYTES" } ], "name": "FluentBitMetricsWithoutWidget", "symbolId": "lib/monitoring/fluentbit/FluentBitConstants:FluentBitMetricsWithoutWidget" }, "cdk-monitoring-constructs.FluentBitMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.FluentBitMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMonitoring.ts", "line": 42 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.FluentBitMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMonitoring.ts", "line": 34 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMonitoring.ts", "line": 66 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMonitoring.ts", "line": 56 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "FluentBitMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMonitoring.ts", "line": 40 }, "name": "filterMetrics", "protected": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMonitoring.ts", "line": 38 }, "name": "inputMetrics", "protected": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMonitoring.ts", "line": 35 }, "name": "logGroupName", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMonitoring.ts", "line": 36 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.FluentBitMetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMonitoring.ts", "line": 39 }, "name": "outputMetrics", "protected": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMonitoring.ts", "line": 37 }, "name": "storageMetrics", "protected": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, "kind": "array" } } } ], "symbolId": "lib/monitoring/fluentbit/FluentBitMonitoring:FluentBitMonitoring" }, "cdk-monitoring-constructs.FluentBitMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.FluentBitMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.FluentBitMetricFactoryProps", "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMonitoring.ts", "line": 18 }, "name": "FluentBitMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Log group that contains FluentBit metric logs." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMonitoring.ts", "line": 24 }, "name": "logGroup", "type": { "fqn": "aws-cdk-lib.aws_logs.ILogGroup" } }, { "abstract": true, "docs": { "default": "false", "remarks": "If you want to get MetricFilters created to have those metrics present in CloudWatch set this flag to true", "stability": "experimental", "summary": "Metrics for input bytes total, output bytes total and output records total are not shown on default dashboard." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitMonitoring.ts", "line": 31 }, "name": "createOptionalMetricFilters", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/monitoring/fluentbit/FluentBitMonitoring:FluentBitMonitoringProps" }, "cdk-monitoring-constructs.FluentBitOutputMetricTag": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.FluentBitOutputMetricTag", "kind": "enum", "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitConstants.ts", "line": 9 }, "members": [ { "docs": { "stability": "experimental" }, "name": "OUTPUT_RETRIES" }, { "docs": { "stability": "experimental" }, "name": "OUTPUT_RETRIES_FAILED" }, { "docs": { "stability": "experimental" }, "name": "OUTPUT_ERRORS" }, { "docs": { "stability": "experimental" }, "name": "OUTPUT_DROPPED_RECORDS" } ], "name": "FluentBitOutputMetricTag", "symbolId": "lib/monitoring/fluentbit/FluentBitConstants:FluentBitOutputMetricTag" }, "cdk-monitoring-constructs.FluentBitStorageMetricTag": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.FluentBitStorageMetricTag", "kind": "enum", "locationInModule": { "filename": "lib/monitoring/fluentbit/FluentBitConstants.ts", "line": 1 }, "members": [ { "docs": { "stability": "experimental" }, "name": "TOTAL_CHUNKS" }, { "docs": { "stability": "experimental" }, "name": "MEM_CHUNKS" }, { "docs": { "stability": "experimental" }, "name": "FS_CHUNKS" }, { "docs": { "stability": "experimental" }, "name": "FS_CHUNKS_UP" }, { "docs": { "stability": "experimental" }, "name": "FS_CHUNKS_DOWN" } ], "name": "FluentBitStorageMetricTag", "symbolId": "lib/monitoring/fluentbit/FluentBitConstants:FluentBitStorageMetricTag" }, "cdk-monitoring-constructs.FullRestartCountThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.FullRestartCountThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory.ts", "line": 19 }, "name": "FullRestartCountThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory.ts", "line": 20 }, "name": "maxFullRestartCount", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory:FullRestartCountThreshold" }, "cdk-monitoring-constructs.GlueJobAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.GlueJobAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 111 }, "name": "GlueJobAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 112 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.GlueJobMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:GlueJobAspectType" }, "cdk-monitoring-constructs.GlueJobMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.GlueJobMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 26 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.GlueJobMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 21 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 102 }, "name": "metricActiveExecutorsAverage", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 70 }, "name": "metricAverageExecutorCpuUsagePercentage", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 86 }, "name": "metricAverageExecutorMemoryUsagePercentage", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 116 }, "name": "metricCompletedStagesSum", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 130 }, "name": "metricCompletedTasksSum", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 158 }, "name": "metricFailedTasksRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 144 }, "name": "metricFailedTasksSum", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 182 }, "name": "metricKilledTasksRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 168 }, "name": "metricKilledTasksSum", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 192 }, "name": "metricMaximumNeededExecutors", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 42 }, "name": "metricTotalReadBytesFromS3", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 56 }, "name": "metricTotalWrittenBytesToS3", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "GlueJobMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 23 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 22 }, "name": "rateComputationMethod", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 24 }, "name": "typeCountDimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-glue/GlueJobMetricFactory:GlueJobMetricFactory" }, "cdk-monitoring-constructs.GlueJobMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.GlueJobMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 13 }, "name": "GlueJobMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 14 }, "name": "jobName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- average", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 18 }, "name": "rateComputationMethod", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-glue/GlueJobMetricFactory:GlueJobMetricFactoryProps" }, "cdk-monitoring-constructs.GlueJobMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.GlueJobMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 74 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.GlueJobMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 51 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 249 }, "name": "createDataMovementWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 269 }, "name": "createErrorCountWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 285 }, "name": "createErrorRateWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 235 }, "name": "createJobExecutionWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 228 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 259 }, "name": "createUtilizationWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 201 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 212 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "GlueJobMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 64 }, "name": "activeExecutorsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 54 }, "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 60 }, "name": "bytesReadFromS3Metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 61 }, "name": "bytesWrittenToS3Metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 65 }, "name": "completedStagesMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 62 }, "name": "cpuUsageMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 55 }, "name": "errorAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 57 }, "name": "errorCountAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 58 }, "name": "errorRateAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 67 }, "name": "failedTaskCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 68 }, "name": "failedTaskRateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 63 }, "name": "heapMemoryUsageMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 71 }, "name": "jobFailedStateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 72 }, "name": "jobTimeoutStateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 69 }, "name": "killedTaskCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 70 }, "name": "killedTaskRateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 66 }, "name": "neededExecutorsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 52 }, "name": "title", "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-glue/GlueJobMonitoring:GlueJobMonitoring" }, "cdk-monitoring-constructs.GlueJobMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.GlueJobMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.GlueJobMetricFactoryProps", "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 38 }, "name": "GlueJobMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 41 }, "name": "addFailedTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 42 }, "name": "addFailedTaskRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 45 }, "name": "addJobFailedStateCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 46 }, "name": "addJobTimeoutStateCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 43 }, "name": "addKilledTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 44 }, "name": "addKilledTaskRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-glue/GlueJobMonitoring:GlueJobMonitoringOptions" }, "cdk-monitoring-constructs.GlueJobMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.GlueJobMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.GlueJobMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 49 }, "name": "GlueJobMonitoringProps", "symbolId": "lib/monitoring/aws-glue/GlueJobMonitoring:GlueJobMonitoringProps" }, "cdk-monitoring-constructs.GraphWidgetType": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.GraphWidgetType", "kind": "enum", "locationInModule": { "filename": "lib/common/widget/types.ts", "line": 10 }, "members": [ { "docs": { "stability": "experimental" }, "name": "BAR" }, { "docs": { "stability": "experimental" }, "name": "LINE" }, { "docs": { "stability": "experimental" }, "name": "PIE" }, { "docs": { "stability": "experimental" }, "name": "SINGLE_VALUE" }, { "docs": { "stability": "experimental" }, "name": "STACKED_AREA" }, { "docs": { "stability": "experimental" }, "name": "TABLE" } ], "name": "GraphWidgetType", "symbolId": "lib/common/widget/types:GraphWidgetType" }, "cdk-monitoring-constructs.HeaderLevel": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.HeaderLevel", "kind": "enum", "locationInModule": { "filename": "lib/dashboard/widget/HeaderWidget.ts", "line": 5 }, "members": [ { "docs": { "stability": "experimental" }, "name": "LARGE" }, { "docs": { "stability": "experimental" }, "name": "MEDIUM" }, { "docs": { "stability": "experimental" }, "name": "SMALL" } ], "name": "HeaderLevel", "symbolId": "lib/dashboard/widget/HeaderWidget:HeaderLevel" }, "cdk-monitoring-constructs.HeaderWidget": { "assembly": "cdk-monitoring-constructs", "base": "aws-cdk-lib.aws_cloudwatch.TextWidget", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.HeaderWidget", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/widget/HeaderWidget.ts", "line": 12 }, "parameters": [ { "name": "text", "type": { "primitive": "string" } }, { "name": "level", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.HeaderLevel" } }, { "name": "description", "optional": true, "type": { "primitive": "string" } }, { "name": "descriptionHeight", "optional": true, "type": { "primitive": "number" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/dashboard/widget/HeaderWidget.ts", "line": 11 }, "name": "HeaderWidget", "symbolId": "lib/dashboard/widget/HeaderWidget:HeaderWidget" }, "cdk-monitoring-constructs.HealthyTaskCountThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.HealthyTaskCountThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 9 }, "name": "HealthyTaskCountThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 10 }, "name": "minHealthyTasks", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/TaskHealthAlarmFactory:HealthyTaskCountThreshold" }, "cdk-monitoring-constructs.HealthyTaskPercentThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.HealthyTaskPercentThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 17 }, "name": "HealthyTaskPercentThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 18 }, "name": "minHealthyTaskPercent", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/TaskHealthAlarmFactory:HealthyTaskPercentThreshold" }, "cdk-monitoring-constructs.HighConnectionCountThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.HighConnectionCountThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/ConnectionAlarmFactory.ts", "line": 13 }, "name": "HighConnectionCountThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/ConnectionAlarmFactory.ts", "line": 14 }, "name": "maxConnectionCount", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/ConnectionAlarmFactory:HighConnectionCountThreshold" }, "cdk-monitoring-constructs.HighMessagesPublishedThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.HighMessagesPublishedThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/TopicAlarmFactory.ts", "line": 13 }, "name": "HighMessagesPublishedThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/TopicAlarmFactory.ts", "line": 14 }, "name": "maxMessagesPublishedCount", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/TopicAlarmFactory:HighMessagesPublishedThreshold" }, "cdk-monitoring-constructs.HighServerlessDatabaseCapacityThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.HighServerlessDatabaseCapacityThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/AuroraAlarmFactory.ts", "line": 9 }, "name": "HighServerlessDatabaseCapacityThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/AuroraAlarmFactory.ts", "line": 11 }, "name": "maxServerlessDatabaseCapacity", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/AuroraAlarmFactory:HighServerlessDatabaseCapacityThreshold" }, "cdk-monitoring-constructs.HighTpsThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.HighTpsThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/TpsAlarmFactory.ts", "line": 13 }, "name": "HighTpsThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/TpsAlarmFactory.ts", "line": 14 }, "name": "maxTps", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/TpsAlarmFactory:HighTpsThreshold" }, "cdk-monitoring-constructs.IAlarmActionStrategy": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental", "summary": "An object that appends actions to alarms." }, "fqn": "cdk-monitoring-constructs.IAlarmActionStrategy", "kind": "interface", "locationInModule": { "filename": "lib/common/alarm/action/IAlarmActionStrategy.ts", "line": 15 }, "methods": [ { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/action/IAlarmActionStrategy.ts", "line": 16 }, "name": "addAlarmActions", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmActionStrategyProps" } } ] } ], "name": "IAlarmActionStrategy", "symbolId": "lib/common/alarm/action/IAlarmActionStrategy:IAlarmActionStrategy" }, "cdk-monitoring-constructs.IAlarmAnnotationStrategy": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental", "summary": "Helper class for creating annotations for alarms." }, "fqn": "cdk-monitoring-constructs.IAlarmAnnotationStrategy", "kind": "interface", "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 29 }, "methods": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Creates annotation based on the metric and alarm properties." }, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 34 }, "name": "createAnnotation", "parameters": [ { "docs": { "summary": "properties necessary to create annotation." }, "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmAnnotationStrategyProps" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" } } } ], "name": "IAlarmAnnotationStrategy", "symbolId": "lib/common/alarm/IAlarmAnnotationStrategy:IAlarmAnnotationStrategy" }, "cdk-monitoring-constructs.IAlarmConsumer": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.IAlarmConsumer", "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/Monitoring.ts", "line": 14 }, "methods": [ { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/Monitoring.ts", "line": 15 }, "name": "consume", "parameters": [ { "name": "alarms", "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" }, "kind": "array" } } } ] } ], "name": "IAlarmConsumer", "symbolId": "lib/common/monitoring/Monitoring:IAlarmConsumer" }, "cdk-monitoring-constructs.IAlarmDedupeStringProcessor": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental", "summary": "Strategy used to finalize dedupe string." }, "fqn": "cdk-monitoring-constructs.IAlarmDedupeStringProcessor", "kind": "interface", "locationInModule": { "filename": "lib/common/alarm/IAlarmDedupeStringProcessor.ts", "line": 4 }, "methods": [ { "abstract": true, "docs": { "returns": "final dedupe string", "stability": "experimental", "summary": "Process the dedupe string which was auto-generated." }, "locationInModule": { "filename": "lib/common/alarm/IAlarmDedupeStringProcessor.ts", "line": 19 }, "name": "processDedupeString", "parameters": [ { "name": "dedupeString", "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } } }, { "abstract": true, "docs": { "returns": "final dedupe string", "stability": "experimental", "summary": "Process the dedupe string which was specified by the user as an override." }, "locationInModule": { "filename": "lib/common/alarm/IAlarmDedupeStringProcessor.ts", "line": 11 }, "name": "processDedupeStringOverride", "parameters": [ { "name": "dedupeString", "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } } } ], "name": "IAlarmDedupeStringProcessor", "symbolId": "lib/common/alarm/IAlarmDedupeStringProcessor:IAlarmDedupeStringProcessor" }, "cdk-monitoring-constructs.IAlarmNamingStrategy": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental", "summary": "Strategy used to name alarms, their widgets, and their dedupe strings." }, "fqn": "cdk-monitoring-constructs.IAlarmNamingStrategy", "kind": "interface", "locationInModule": { "filename": "lib/common/alarm/IAlarmNamingStrategy.ts", "line": 16 }, "methods": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "How to generate the deduplication string for an alarm." }, "locationInModule": { "filename": "lib/common/alarm/IAlarmNamingStrategy.ts", "line": 34 }, "name": "getDedupeString", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmNamingInput" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "How to generate the name of an alarm." }, "locationInModule": { "filename": "lib/common/alarm/IAlarmNamingStrategy.ts", "line": 22 }, "name": "getName", "parameters": [ { "docs": { "summary": "AlarmNamingInput." }, "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmNamingInput" } } ], "returns": { "type": { "primitive": "string" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "How to generate the label for the alarm displayed on a widget." }, "locationInModule": { "filename": "lib/common/alarm/IAlarmNamingStrategy.ts", "line": 29 }, "name": "getWidgetLabel", "parameters": [ { "docs": { "summary": "AlarmNamingInput." }, "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmNamingInput" } } ], "returns": { "type": { "primitive": "string" } } } ], "name": "IAlarmNamingStrategy", "symbolId": "lib/common/alarm/IAlarmNamingStrategy:IAlarmNamingStrategy" }, "cdk-monitoring-constructs.IDashboardFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.IDashboardFactory", "kind": "interface", "locationInModule": { "filename": "lib/dashboard/IDashboardFactory.ts", "line": 39 }, "methods": [ { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/IDashboardFactory.ts", "line": 40 }, "name": "addSegment", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.IDashboardFactoryProps" } } ] }, { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/IDashboardFactory.ts", "line": 46 }, "name": "createdAlarmDashboard", "returns": { "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/IDashboardFactory.ts", "line": 42 }, "name": "createdDashboard", "returns": { "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/IDashboardFactory.ts", "line": 44 }, "name": "createdSummaryDashboard", "returns": { "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" } } } ], "name": "IDashboardFactory", "symbolId": "lib/dashboard/IDashboardFactory:IDashboardFactory" }, "cdk-monitoring-constructs.IDashboardFactoryProps": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.IDashboardFactoryProps", "kind": "interface", "locationInModule": { "filename": "lib/dashboard/IDashboardFactory.ts", "line": 26 }, "name": "IDashboardFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Segment to be placed on the dashboard." }, "locationInModule": { "filename": "lib/dashboard/IDashboardFactory.ts", "line": 30 }, "name": "segment", "type": { "fqn": "cdk-monitoring-constructs.IDashboardSegment" } }, { "abstract": true, "docs": { "default": "- all default", "stability": "experimental", "summary": "Dashboard placement override props." }, "locationInModule": { "filename": "lib/dashboard/IDashboardFactory.ts", "line": 36 }, "name": "overrideProps", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringDashboardsOverrideProps" } } ], "symbolId": "lib/dashboard/IDashboardFactory:IDashboardFactoryProps" }, "cdk-monitoring-constructs.IDashboardSegment": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.IDashboardSegment", "kind": "interface", "locationInModule": { "filename": "lib/dashboard/DashboardSegment.ts", "line": 3 }, "methods": [ { "abstract": true, "docs": { "remarks": "These should go to the runbook or service dashboard.", "stability": "experimental", "summary": "Returns widgets for all alarms." }, "locationInModule": { "filename": "lib/dashboard/DashboardSegment.ts", "line": 7 }, "name": "alarmWidgets", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "abstract": true, "docs": { "remarks": "These should go to the team OPS dashboard.", "stability": "experimental", "summary": "Returns widgets for the summary." }, "locationInModule": { "filename": "lib/dashboard/DashboardSegment.ts", "line": 12 }, "name": "summaryWidgets", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "abstract": true, "docs": { "remarks": "These should go to the detailed service dashboard.", "stability": "experimental", "summary": "Returns all widgets." }, "locationInModule": { "filename": "lib/dashboard/DashboardSegment.ts", "line": 17 }, "name": "widgets", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "IDashboardSegment", "symbolId": "lib/dashboard/DashboardSegment:IDashboardSegment" }, "cdk-monitoring-constructs.IDynamicDashboardFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental", "summary": "This dashboard factory interface provides for dynamic dashboard generation through IDynamicDashboard segments which will return different content depending on the dashboard type." }, "fqn": "cdk-monitoring-constructs.IDynamicDashboardFactory", "kind": "interface", "locationInModule": { "filename": "lib/dashboard/IDynamicDashboardFactory.ts", "line": 9 }, "methods": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Adds a dynamic dashboard segment." }, "locationInModule": { "filename": "lib/dashboard/IDynamicDashboardFactory.ts", "line": 14 }, "name": "addDynamicSegment", "parameters": [ { "docs": { "summary": "IDynamicDashboardSegment." }, "name": "segment", "type": { "fqn": "cdk-monitoring-constructs.IDynamicDashboardSegment" } } ] }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Gets the dashboard for the requested dashboard type." }, "locationInModule": { "filename": "lib/dashboard/IDynamicDashboardFactory.ts", "line": 20 }, "name": "getDashboard", "parameters": [ { "name": "type", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" } } } ], "name": "IDynamicDashboardFactory", "symbolId": "lib/dashboard/IDynamicDashboardFactory:IDynamicDashboardFactory" }, "cdk-monitoring-constructs.IDynamicDashboardSegment": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.IDynamicDashboardSegment", "kind": "interface", "locationInModule": { "filename": "lib/dashboard/DynamicDashboardSegment.ts", "line": 5 }, "methods": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Returns widgets for the requested dashboard type." }, "locationInModule": { "filename": "lib/dashboard/DynamicDashboardSegment.ts", "line": 10 }, "name": "widgetsForDashboard", "parameters": [ { "docs": { "summary": "name of dashboard for which widgets are generated." }, "name": "name", "type": { "primitive": "string" } } ], "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "IDynamicDashboardSegment", "symbolId": "lib/dashboard/DynamicDashboardSegment:IDynamicDashboardSegment" }, "cdk-monitoring-constructs.IEC2MetricFactoryStrategy": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.IEC2MetricFactoryStrategy", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2MetricFactory.ts", "line": 14 }, "methods": [ { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2MetricFactory.ts", "line": 15 }, "name": "createMetrics", "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "metricName", "type": { "primitive": "string" } }, { "name": "statistic", "type": { "fqn": "cdk-monitoring-constructs.MetricStatistic" } }, { "name": "region", "optional": true, "type": { "primitive": "string" } }, { "name": "account", "optional": true, "type": { "primitive": "string" } }, { "name": "label", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } }, "kind": "array" } } } } ], "name": "IEC2MetricFactoryStrategy", "symbolId": "lib/monitoring/aws-ec2/EC2MetricFactory:IEC2MetricFactoryStrategy" }, "cdk-monitoring-constructs.ILoadBalancerMetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental", "summary": "Common interface for load-balancer based service metric factories." }, "fqn": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/LoadBalancerMetricFactory.ts", "line": 96 }, "methods": [ { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/LoadBalancerMetricFactory.ts", "line": 103 }, "name": "metricActiveConnectionCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/LoadBalancerMetricFactory.ts", "line": 97 }, "name": "metricHealthyTaskCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/LoadBalancerMetricFactory.ts", "line": 101 }, "name": "metricHealthyTaskInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/LoadBalancerMetricFactory.ts", "line": 105 }, "name": "metricNewConnectionCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/LoadBalancerMetricFactory.ts", "line": 109 }, "name": "metricProcessedBytesMin", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/LoadBalancerMetricFactory.ts", "line": 107 }, "name": "metricUnhealthyRoutingCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/LoadBalancerMetricFactory.ts", "line": 99 }, "name": "metricUnhealthyTaskCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "ILoadBalancerMetricFactory", "symbolId": "lib/monitoring/aws-loadbalancing/LoadBalancerMetricFactory:ILoadBalancerMetricFactory" }, "cdk-monitoring-constructs.IMetricAdjuster": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental", "summary": "Adjusts a metric before creating adding an alarm to it." }, "fqn": "cdk-monitoring-constructs.IMetricAdjuster", "kind": "interface", "locationInModule": { "filename": "lib/common/alarm/metric-adjuster/IMetricAdjuster.ts", "line": 8 }, "methods": [ { "abstract": true, "docs": { "returns": "The adjusted metric.", "stability": "experimental", "summary": "Adjusts a metric." }, "locationInModule": { "filename": "lib/common/alarm/metric-adjuster/IMetricAdjuster.ts", "line": 16 }, "name": "adjustMetric", "parameters": [ { "docs": { "summary": "The metric to adjust." }, "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "summary": "The alarm scope." }, "name": "alarmScope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "The props specified for adding the alarm." }, "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AddAlarmProps" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "IMetricAdjuster", "symbolId": "lib/common/alarm/metric-adjuster/IMetricAdjuster:IMetricAdjuster" }, "cdk-monitoring-constructs.IPublisherConsumer": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.IPublisherConsumer", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring.ts", "line": 30 }, "methods": [ { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring.ts", "line": 31 }, "name": "consume", "parameters": [ { "name": "lambdaFunction", "type": { "fqn": "aws-cdk-lib.aws_lambda.IFunction" } } ] } ], "name": "IPublisherConsumer", "symbolId": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring:IPublisherConsumer" }, "cdk-monitoring-constructs.IWidgetFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental", "summary": "Strategy for creating widgets." }, "fqn": "cdk-monitoring-constructs.IWidgetFactory", "kind": "interface", "locationInModule": { "filename": "lib/dashboard/IWidgetFactory.ts", "line": 8 }, "methods": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Create widget representing an alarm detail." }, "locationInModule": { "filename": "lib/dashboard/IWidgetFactory.ts", "line": 13 }, "name": "createAlarmDetailWidget", "parameters": [ { "docs": { "summary": "alarm to represent." }, "name": "alarm", "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" } } } ], "name": "IWidgetFactory", "symbolId": "lib/dashboard/IWidgetFactory:IWidgetFactory" }, "cdk-monitoring-constructs.KeyValue": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KeyValue", "kind": "interface", "locationInModule": { "filename": "lib/dashboard/widget/KeyValueTableWidget.ts", "line": 5 }, "name": "KeyValue", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/KeyValueTableWidget.ts", "line": 6 }, "name": "key", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/KeyValueTableWidget.ts", "line": 7 }, "name": "value", "type": { "primitive": "string" } } ], "symbolId": "lib/dashboard/widget/KeyValueTableWidget:KeyValue" }, "cdk-monitoring-constructs.KeyValueTableWidget": { "assembly": "cdk-monitoring-constructs", "base": "aws-cdk-lib.aws_cloudwatch.TextWidget", "docs": { "stability": "experimental", "summary": "A widget that displays key-value pairs in a table format." }, "fqn": "cdk-monitoring-constructs.KeyValueTableWidget", "initializer": { "docs": { "stability": "experimental", "summary": "Creates a key-value table widget." }, "locationInModule": { "filename": "lib/dashboard/widget/KeyValueTableWidget.ts", "line": 18 }, "parameters": [ { "docs": { "summary": "An array of key-value pairs as objects." }, "name": "data", "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.KeyValue" }, "kind": "array" } } } ] }, "kind": "class", "locationInModule": { "filename": "lib/dashboard/widget/KeyValueTableWidget.ts", "line": 13 }, "name": "KeyValueTableWidget", "symbolId": "lib/dashboard/widget/KeyValueTableWidget:KeyValueTableWidget" }, "cdk-monitoring-constructs.KinesisAlarmFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisAlarmFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 42 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 39 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 181 }, "name": "addConsumerIteratorMaxAgeAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MaxIteratorAgeThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 201 }, "name": "addConsumerSubscribeToShardRateExceededAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.ConsumerRateExceededThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 222 }, "name": "addConsumerSubscribeToShardSuccessAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MinConsumerSubscribeToShardSuccessThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 111 }, "name": "addFirehoseStreamExceedSafetyThresholdAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "metricName", "type": { "primitive": "string" } }, { "name": "quotaName", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.FirehoseStreamLimitThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 46 }, "name": "addIteratorMaxAgeAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MaxIteratorAgeThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 141 }, "name": "addProvisionedReadThroughputExceededAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.RecordsThrottledThreshold" } }, { "name": "disambiguator", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 161 }, "name": "addProvisionedWriteThroughputExceededAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.RecordsThrottledThreshold" } }, { "name": "disambiguator", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 89 }, "name": "addPutRecordsFailedAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.RecordsFailedThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 67 }, "name": "addPutRecordsThrottledAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.RecordsThrottledThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } } ], "name": "KinesisAlarmFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 40 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ], "symbolId": "lib/common/monitoring/alarms/KinesisAlarmFactory:KinesisAlarmFactory" }, "cdk-monitoring-constructs.KinesisDataAnalyticsAlarmFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisDataAnalyticsAlarmFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory.ts", "line": 32 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory.ts", "line": 28 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory.ts", "line": 98 }, "name": "addBackPressuredTimeMsPerSecondAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MaxBackPressuredTimeMsPerSecondThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory.ts", "line": 118 }, "name": "addCheckpointFailureCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory.ts", "line": 131 }, "name": "addCheckpointFailureRateAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory.ts", "line": 37 }, "name": "addDowntimeAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MaxDowntimeThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory.ts", "line": 58 }, "name": "addFullRestartAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.FullRestartCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory.ts", "line": 78 }, "name": "addFullRestartRateAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } } ], "name": "KinesisDataAnalyticsAlarmFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory.ts", "line": 29 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory.ts", "line": 30 }, "name": "errorAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } } ], "symbolId": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory:KinesisDataAnalyticsAlarmFactory" }, "cdk-monitoring-constructs.KinesisDataAnalyticsAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisDataAnalyticsAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 115 }, "name": "KinesisDataAnalyticsAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 117 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.KinesisDataAnalyticsMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:KinesisDataAnalyticsAspectType" }, "cdk-monitoring-constructs.KinesisDataAnalyticsMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "see": "https://docs.aws.amazon.com/kinesisanalytics/latest/java/metrics-dimensions.html", "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisDataAnalyticsMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 30 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.KinesisDataAnalyticsMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 27 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 121 }, "name": "metricBackPressuredTimeMsPerSecond", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 128 }, "name": "metricCheckpointFailureRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 92 }, "name": "metricCpuUtilizationPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 48 }, "name": "metricDowntimeMs", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 140 }, "name": "metricFullRestartRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 62 }, "name": "metricFullRestartsCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 99 }, "name": "metricHeapMemoryUtilizationPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 41 }, "name": "metricKPUsCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 77 }, "name": "metricLastCheckpointDurationMs", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 84 }, "name": "metricLastCheckpointSizeBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 69 }, "name": "metricNumberOfFailedCheckpointsCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 113 }, "name": "metricOldGenerationGCCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 106 }, "name": "metricOldGenerationGCTimeMs", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 55 }, "name": "metricUptimeMs", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "KinesisDataAnalyticsMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 28 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory:KinesisDataAnalyticsMetricFactory" }, "cdk-monitoring-constructs.KinesisDataAnalyticsMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisDataAnalyticsMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 10 }, "name": "KinesisDataAnalyticsMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 12 }, "name": "application", "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory:KinesisDataAnalyticsMetricFactoryProps" }, "cdk-monitoring-constructs.KinesisDataAnalyticsMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisDataAnalyticsMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 84 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.KinesisDataAnalyticsMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 58 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 282 }, "name": "createBackPressuredTimeWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 257 }, "name": "createDownTimeWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 268 }, "name": "createFullRestartsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 327 }, "name": "createGarbageCollectionWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 234 }, "name": "createKPUWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 307 }, "name": "createLastCheckpointDurationWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 317 }, "name": "createLastCheckpointSizeWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 293 }, "name": "createNumberOfFailedCheckpointsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 244 }, "name": "createResourceUtilizationWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 226 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 211 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 218 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "KinesisDataAnalyticsMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 66 }, "name": "backPressuredTimeMsPerSecondAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 82 }, "name": "backPressuredTimeMsPerSecondMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 67 }, "name": "checkpointFailureCountAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 68 }, "name": "checkpointFailureRateAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 80 }, "name": "checkpointFailureRateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 70 }, "name": "cpuUtilizationPercentMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 63 }, "name": "downtimeAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 71 }, "name": "downtimeMsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 64 }, "name": "fullRestartAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 65 }, "name": "fullRestartRateAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 81 }, "name": "fullRestartRateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 72 }, "name": "fullRestartsCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 73 }, "name": "heapMemoryUtilizationPercentMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 62 }, "name": "kdaAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.KinesisDataAnalyticsAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 74 }, "name": "kpusCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 75 }, "name": "lastCheckpointDurationMsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 76 }, "name": "lastCheckpointSizeBytesMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 77 }, "name": "numberOfFailedCheckpointsCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 78 }, "name": "oldGenerationGCCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 79 }, "name": "oldGenerationGCTimeMsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 59 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 60 }, "name": "kinesisDataAnalyticsUrl", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring:KinesisDataAnalyticsMonitoring" }, "cdk-monitoring-constructs.KinesisDataAnalyticsMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisDataAnalyticsMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 36 }, "name": "KinesisDataAnalyticsMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 44 }, "name": "addBackPressuredTimeMsPerSecondAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MaxBackPressuredTimeMsPerSecondThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 49 }, "name": "addCheckpointFailureCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 51 }, "name": "addCheckpointFailureRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 38 }, "name": "addDowntimeAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MaxDowntimeThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 40 }, "name": "addFullRestartCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.FullRestartCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 42 }, "name": "addFullRestartRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring:KinesisDataAnalyticsMonitoringOptions" }, "cdk-monitoring-constructs.KinesisDataAnalyticsMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisDataAnalyticsMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.KinesisDataAnalyticsMetricFactoryProps", "cdk-monitoring-constructs.KinesisDataAnalyticsMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 54 }, "name": "KinesisDataAnalyticsMonitoringProps", "symbolId": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring:KinesisDataAnalyticsMonitoringProps" }, "cdk-monitoring-constructs.KinesisDataStreamAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisDataStreamAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 120 }, "name": "KinesisDataStreamAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 121 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.KinesisDataStreamMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:KinesisDataStreamAspectType" }, "cdk-monitoring-constructs.KinesisDataStreamConsumerAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisDataStreamConsumerAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 124 }, "name": "KinesisDataStreamConsumerAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 126 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.KinesisDataStreamConsumerMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:KinesisDataStreamConsumerAspectType" }, "cdk-monitoring-constructs.KinesisDataStreamConsumerMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "remarks": "Dimensions: {StreamName, ConsumerName}.", "see": "https://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html#kinesis-metrics-consumer", "stability": "experimental", "summary": "Metrics for a single enhanced fan-out (EFO) consumer of a Kinesis data stream." }, "fqn": "cdk-monitoring-constructs.KinesisDataStreamConsumerMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMetricFactory.ts", "line": 27 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.KinesisDataStreamConsumerMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMetricFactory.ts", "line": 24 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Max lag (ms) for events delivered to this EFO consumer." }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMetricFactory.ts", "line": 39 }, "name": "metricSubscribeToShardEventMillisBehindLatestMaxMs", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental", "summary": "Records delivered to this consumer." }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMetricFactory.ts", "line": 99 }, "name": "metricSubscribeToShardEventRecordsSumCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental", "summary": "Success rate of individual SubscribeToShardEvent deliveries within an open subscription." }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMetricFactory.ts", "line": 84 }, "name": "metricSubscribeToShardEventSuccessAverage", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental", "summary": "Bytes delivered to this consumer." }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMetricFactory.ts", "line": 114 }, "name": "metricSubscribeToShardEventSumBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental", "summary": "Rate at which SubscribeToShard calls for this consumer are throttled." }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMetricFactory.ts", "line": 54 }, "name": "metricSubscribeToShardRateExceededAverage", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental", "summary": "Success rate of SubscribeToShard calls (connect handshake)." }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMetricFactory.ts", "line": 69 }, "name": "metricSubscribeToShardSuccessAverage", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "KinesisDataStreamConsumerMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMetricFactory.ts", "line": 25 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMetricFactory:KinesisDataStreamConsumerMetricFactory" }, "cdk-monitoring-constructs.KinesisDataStreamConsumerMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisDataStreamConsumerMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMetricFactory.ts", "line": 12 }, "name": "KinesisDataStreamConsumerMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMetricFactory.ts", "line": 15 }, "name": "consumerName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMetricFactory.ts", "line": 14 }, "name": "streamName", "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMetricFactory:KinesisDataStreamConsumerMetricFactoryProps" }, "cdk-monitoring-constructs.KinesisDataStreamConsumerMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisDataStreamConsumerMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 71 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.KinesisDataStreamConsumerMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 55 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 241 }, "name": "createBytesWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 195 }, "name": "createMillisBehindLatestWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 220 }, "name": "createRateExceededWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 231 }, "name": "createRecordsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 206 }, "name": "createSubscribeSuccessWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 187 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 149 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 166 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "KinesisDataStreamConsumerMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 60 }, "name": "ageAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 69 }, "name": "bytesMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 59 }, "name": "kinesisAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.KinesisAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 64 }, "name": "millisBehindLatestMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 61 }, "name": "rateExceededAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 65 }, "name": "rateExceededMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 68 }, "name": "recordsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 62 }, "name": "subscribeSuccessAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 67 }, "name": "subscribeToShardEventSuccessMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 66 }, "name": "subscribeToShardSuccessMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 56 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 57 }, "name": "streamUrl", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring:KinesisDataStreamConsumerMonitoring" }, "cdk-monitoring-constructs.KinesisDataStreamConsumerMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisDataStreamConsumerMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 35 }, "name": "KinesisDataStreamConsumerMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 37 }, "name": "addConsumerIteratorMaxAgeAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MaxIteratorAgeThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 41 }, "name": "addConsumerSubscribeToShardRateExceededAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ConsumerRateExceededThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 45 }, "name": "addConsumerSubscribeToShardSuccessAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MinConsumerSubscribeToShardSuccessThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring:KinesisDataStreamConsumerMonitoringOptions" }, "cdk-monitoring-constructs.KinesisDataStreamConsumerMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisDataStreamConsumerMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.KinesisDataStreamConsumerMetricFactoryProps", "cdk-monitoring-constructs.KinesisDataStreamConsumerMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring.ts", "line": 51 }, "name": "KinesisDataStreamConsumerMonitoringProps", "symbolId": "lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMonitoring:KinesisDataStreamConsumerMonitoringProps" }, "cdk-monitoring-constructs.KinesisDataStreamMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "see": "https://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html", "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisDataStreamMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 23 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.KinesisDataStreamMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 20 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 48 }, "name": "metricGetRecordsIteratorAgeMaxMs", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 62 }, "name": "metricGetRecordsLatencyAverageMs", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 90 }, "name": "metricGetRecordsSuccessCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 34 }, "name": "metricGetRecordsSumBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 76 }, "name": "metricGetRecordsSumCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 104 }, "name": "metricIncomingDataSumBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 118 }, "name": "metricIncomingDataSumCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 146 }, "name": "metricPutRecordLatencyAverageMs", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 244 }, "name": "metricPutRecordsFailedRecordsCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 188 }, "name": "metricPutRecordsLatencyAverageMs", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 202 }, "name": "metricPutRecordsSuccessCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 216 }, "name": "metricPutRecordsSuccessfulRecordsCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 174 }, "name": "metricPutRecordsSumBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 258 }, "name": "metricPutRecordsThrottledRecordsCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 230 }, "name": "metricPutRecordsTotalRecordsCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 160 }, "name": "metricPutRecordSuccessCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 132 }, "name": "metricPutRecordSumBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 286 }, "name": "metricReadProvisionedThroughputExceeded", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "deprecated": "please use `metricReadProvisionedThroughputExceeded` instead", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 275 }, "name": "metricReadProvisionedThroughputExceededPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 300 }, "name": "metricWriteProvisionedThroughputExceeded", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "deprecated": "please use `metricWriteProvisionedThroughputExceeded` instead", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 282 }, "name": "metricWriteProvisionedThroughputExceededPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "KinesisDataStreamMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 21 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory:KinesisDataStreamMetricFactory" }, "cdk-monitoring-constructs.KinesisDataStreamMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisDataStreamMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 12 }, "name": "KinesisDataStreamMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 14 }, "name": "streamName", "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory:KinesisDataStreamMetricFactoryProps" }, "cdk-monitoring-constructs.KinesisDataStreamMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisDataStreamMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 87 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.KinesisDataStreamMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 58 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 286 }, "name": "createCapacityWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 251 }, "name": "createIncomingDataWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 261 }, "name": "createIteratorAgeWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 272 }, "name": "createLatencyWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 314 }, "name": "createOperationWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 328 }, "name": "createRecordNumberWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 300 }, "name": "createRecordSizeWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 237 }, "name": "createSecondAdditionalRow", "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Row" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 243 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 204 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 216 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "KinesisDataStreamMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 63 }, "name": "ageAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 72 }, "name": "incomingDataSumBytesMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 73 }, "name": "incomingDataSumCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 62 }, "name": "kinesisAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.KinesisAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 68 }, "name": "metricGetRecordsIteratorAge", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 69 }, "name": "metricGetRecordsLatencyAverage", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 71 }, "name": "metricGetRecordsSuccessCount", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 70 }, "name": "metricGetRecordsSumCount", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 67 }, "name": "metricGetRecordSumBytes", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 64 }, "name": "provisionedCapacityAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 75 }, "name": "putRecordLatencyAverageMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 82 }, "name": "putRecordsFailedRecordsCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 78 }, "name": "putRecordsLatencyAverageMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 79 }, "name": "putRecordsSuccessCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 81 }, "name": "putRecordsSuccessfulRecordsCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 77 }, "name": "putRecordsSumBytesMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 83 }, "name": "putRecordsThrottledRecordsCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 80 }, "name": "putRecordsTotalRecordsCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 76 }, "name": "putRecordSuccessCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 74 }, "name": "putRecordSumBytesMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 84 }, "name": "readProvisionedThroughputExceededMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 65 }, "name": "recordCountAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 59 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 85 }, "name": "writeProvisionedThroughputExceededMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 60 }, "name": "streamUrl", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring:KinesisDataStreamMonitoring" }, "cdk-monitoring-constructs.KinesisDataStreamMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisDataStreamMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 35 }, "name": "KinesisDataStreamMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 37 }, "name": "addIteratorMaxAgeAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MaxIteratorAgeThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 42 }, "name": "addPutRecordsFailedAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.RecordsFailedThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 38 }, "name": "addPutRecordsThrottledAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.RecordsThrottledThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 44 }, "name": "addReadProvisionedThroughputExceededAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.RecordsThrottledThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 43 }, "name": "addThrottledRecordsAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.RecordsThrottledThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 48 }, "name": "addWriteProvisionedThroughputExceededAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.RecordsThrottledThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring:KinesisDataStreamMonitoringOptions" }, "cdk-monitoring-constructs.KinesisDataStreamMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisDataStreamMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.KinesisDataStreamMetricFactoryProps", "cdk-monitoring-constructs.KinesisDataStreamMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 54 }, "name": "KinesisDataStreamMonitoringProps", "symbolId": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring:KinesisDataStreamMonitoringProps" }, "cdk-monitoring-constructs.KinesisFirehoseAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisFirehoseAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 129 }, "name": "KinesisFirehoseAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 130 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.KinesisFirehoseMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:KinesisFirehoseAspectType" }, "cdk-monitoring-constructs.KinesisFirehoseMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "see": "https://docs.aws.amazon.com/firehose/latest/dev/monitoring-with-cloudwatch-metrics.html", "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisFirehoseMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 23 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.KinesisFirehoseMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 20 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 179 }, "name": "metricBytesPerSecondLimit", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 48 }, "name": "metricFailedConversionCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 62 }, "name": "metricIncomingBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 146 }, "name": "metricIncomingBytesToLimitRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 76 }, "name": "metricIncomingPutRequests", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 168 }, "name": "metricIncomingPutRequestsToLimitRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 90 }, "name": "metricIncomingRecordCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 157 }, "name": "metricIncomingRecordsToLimitRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 132 }, "name": "metricPutRecordBatchLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 118 }, "name": "metricPutRecordLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 207 }, "name": "metricPutRequestsPerSecondLimit", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 193 }, "name": "metricRecordsPerSecondLimit", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 34 }, "name": "metricSuccessfulConversionCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 104 }, "name": "metricThrottledRecordCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "KinesisFirehoseMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 21 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory:KinesisFirehoseMetricFactory" }, "cdk-monitoring-constructs.KinesisFirehoseMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisFirehoseMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 12 }, "name": "KinesisFirehoseMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 14 }, "name": "deliveryStreamName", "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory:KinesisFirehoseMetricFactoryProps" }, "cdk-monitoring-constructs.KinesisFirehoseMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisFirehoseMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 84 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.KinesisFirehoseMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 62 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 248 }, "name": "createConversionWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 227 }, "name": "createIncomingRecordWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 238 }, "name": "createLatencyWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 258 }, "name": "createLimitWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 219 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 185 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 201 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "KinesisFirehoseMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 76 }, "name": "failedConversionMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 70 }, "name": "incomingBytesMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 80 }, "name": "incomingBytesToLimitRate", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 68 }, "name": "incomingLimitAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 82 }, "name": "incomingPutRequestsToLimitRate", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 71 }, "name": "incomingRecordsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 81 }, "name": "incomingRecordsToLimitRate", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 74 }, "name": "isDataFormatConversionEnabled", "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 66 }, "name": "kinesisAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.KinesisAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 79 }, "name": "putRecordBatchLatency", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 78 }, "name": "putRecordLatency", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 67 }, "name": "recordCountAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 75 }, "name": "successfulConversionMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 72 }, "name": "throttledRecordsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 63 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 64 }, "name": "streamUrl", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring:KinesisFirehoseMonitoring" }, "cdk-monitoring-constructs.KinesisFirehoseMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisFirehoseMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 34 }, "name": "KinesisFirehoseMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 44 }, "name": "addIncomingBytesExceedThresholdAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.FirehoseStreamLimitThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 52 }, "name": "addIncomingPutRequestsExceedThresholdAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.FirehoseStreamLimitThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 48 }, "name": "addIncomingRecordsExceedThresholdAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.FirehoseStreamLimitThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 43 }, "name": "addRecordsThrottledAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.RecordsThrottledThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- true", "remarks": "This impacts what widgets are shown.", "see": "https://docs.aws.amazon.com/firehose/latest/dev/enable-record-format-conversion.html", "stability": "experimental", "summary": "Indicates that the Kinesis Firehose has record format conversion enabled." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 42 }, "name": "isDataFormatConversionEnabled", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring:KinesisFirehoseMonitoringOptions" }, "cdk-monitoring-constructs.KinesisFirehoseMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KinesisFirehoseMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.KinesisFirehoseMetricFactoryProps", "cdk-monitoring-constructs.KinesisFirehoseMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 58 }, "name": "KinesisFirehoseMonitoringProps", "symbolId": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring:KinesisFirehoseMonitoringProps" }, "cdk-monitoring-constructs.LambdaAlarmActionStrategy": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental", "summary": "Alarm action strategy that triggers a Lambda function." }, "fqn": "cdk-monitoring-constructs.LambdaAlarmActionStrategy", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/action/LambdaAlarmActionStrategy.ts", "line": 21 }, "parameters": [ { "name": "lambdaFunction", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_lambda.IAlias" }, { "fqn": "aws-cdk-lib.aws_lambda.IFunction" }, { "fqn": "aws-cdk-lib.aws_lambda.IVersion" } ] } } } ] }, "interfaces": [ "cdk-monitoring-constructs.IAlarmActionStrategy" ], "kind": "class", "locationInModule": { "filename": "lib/common/alarm/action/LambdaAlarmActionStrategy.ts", "line": 18 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/action/LambdaAlarmActionStrategy.ts", "line": 25 }, "name": "addAlarmActions", "overrides": "cdk-monitoring-constructs.IAlarmActionStrategy", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmActionStrategyProps" } } ] } ], "name": "LambdaAlarmActionStrategy", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/action/LambdaAlarmActionStrategy.ts", "line": 19 }, "name": "lambdaFunction", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_lambda.IAlias" }, { "fqn": "aws-cdk-lib.aws_lambda.IFunction" }, { "fqn": "aws-cdk-lib.aws_lambda.IVersion" } ] } } } ], "symbolId": "lib/common/alarm/action/LambdaAlarmActionStrategy:LambdaAlarmActionStrategy" }, "cdk-monitoring-constructs.LambdaFunctionAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.LambdaFunctionAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 133 }, "name": "LambdaFunctionAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 134 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.LambdaFunctionMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:LambdaFunctionAspectType" }, "cdk-monitoring-constructs.LambdaFunctionEnhancedMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.LambdaFunctionEnhancedMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 20 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.LambdaFunctionEnhancedMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 17 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 45 }, "name": "enhancedMetricAvgCpuTotalTime", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 93 }, "name": "enhancedMetricAvgInitDuration", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 69 }, "name": "enhancedMetricAvgMemoryUtilization", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 127 }, "name": "enhancedMetricFunctionCost", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 101 }, "name": "enhancedMetricInitDuration", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 29 }, "name": "enhancedMetricMaxCpuTotalTime", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 77 }, "name": "enhancedMetricMaxInitDuration", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 53 }, "name": "enhancedMetricMaxMemoryUtilization", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 109 }, "name": "enhancedMetricMaxTotalMemory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 37 }, "name": "enhancedMetricP90CpuTotalTime", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 85 }, "name": "enhancedMetricP90InitDuration", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 61 }, "name": "enhancedMetricP90MemoryUtilization", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "LambdaFunctionEnhancedMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 18 }, "name": "lambdaFunction", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_lambda.IFunction" } } ], "symbolId": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory:LambdaFunctionEnhancedMetricFactory" }, "cdk-monitoring-constructs.LambdaFunctionEnhancedMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.LambdaFunctionEnhancedMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 12 }, "name": "LambdaFunctionEnhancedMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 14 }, "name": "lambdaFunction", "type": { "fqn": "aws-cdk-lib.aws_lambda.IFunction" } } ], "symbolId": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory:LambdaFunctionEnhancedMetricFactoryProps" }, "cdk-monitoring-constructs.LambdaFunctionMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.LambdaFunctionMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 41 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.LambdaFunctionMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 36 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 150 }, "name": "metricConcurrentExecutions", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 99 }, "name": "metricFaultCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 109 }, "name": "metricFaultRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 70 }, "name": "metricInvocationCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 60 }, "name": "metricInvocationRate", "parameters": [ { "name": "rateComputationMethod", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 118 }, "name": "metricLatencyInMillis", "parameters": [ { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "deprecated": "Use {@link metricLatencyInMillis } instead.", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 146 }, "name": "metricLatencyP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "deprecated": "Use {@link metricLatencyInMillis } instead.", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 139 }, "name": "metricLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "deprecated": "Use {@link metricLatencyInMillis } instead.", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 132 }, "name": "metricLatencyP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 181 }, "name": "metricMaxIteratorAgeInMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 192 }, "name": "metricMaxOffsetLagInNumberOfRecords", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 161 }, "name": "metricProvisionedConcurrencySpilloverInvocations", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 172 }, "name": "metricProvisionedConcurrencySpilloverRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 80 }, "name": "metricThrottlesCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 90 }, "name": "metricThrottlesRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "deprecated": "Use {@link metricInvocationRate } instead.", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 56 }, "name": "metricTps", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "LambdaFunctionMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 38 }, "name": "fillTpsWithZeroes", "protected": true, "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 37 }, "name": "lambdaFunction", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_lambda.IFunction" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 39 }, "name": "rateComputationMethod", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory:LambdaFunctionMetricFactory" }, "cdk-monitoring-constructs.LambdaFunctionMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.LambdaFunctionMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 14 }, "name": "LambdaFunctionMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 16 }, "name": "lambdaFunction", "type": { "fqn": "aws-cdk-lib.aws_lambda.IFunction" } }, { "abstract": true, "docs": { "default": "- true", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 20 }, "name": "fillTpsWithZeroes", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- false", "remarks": "To enable Lambda Insights on your Lambda function, see\nhttps://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights-Getting-Started-clouddevelopmentkit.html", "stability": "experimental", "summary": "Generate dashboard charts for Lambda Insights metrics." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 33 }, "name": "lambdaInsightsEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- average", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 24 }, "name": "rateComputationMethod", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory:LambdaFunctionMetricFactoryProps" }, "cdk-monitoring-constructs.LambdaFunctionMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.LambdaFunctionMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 225 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.LambdaFunctionMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 167 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 782 }, "name": "createErrorCountWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 793 }, "name": "createErrorRateWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 818 }, "name": "createInvocationWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 834 }, "name": "createIteratorAgeWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 856 }, "name": "createLambdaInsightsCpuWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 907 }, "name": "createLambdaInsightsFunctionCostWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 890 }, "name": "createLambdaInsightsInitDurationWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 873 }, "name": "createLambdaInsightsMemoryWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 767 }, "name": "createLatencyWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 845 }, "name": "createOffsetLagWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 804 }, "name": "createRateWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 748 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 756 }, "name": "createTpsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 666 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 675 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "LambdaFunctionMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 178 }, "name": "ageAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AgeAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 173 }, "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 203 }, "name": "concurrentExecutionsCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 187 }, "name": "cpuTotalTimeAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 174 }, "name": "errorAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 182 }, "name": "errorCountAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 183 }, "name": "errorRateAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 198 }, "name": "faultCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 199 }, "name": "faultRateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 191 }, "name": "initDurationAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 184 }, "name": "invocationCountAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 200 }, "name": "invocationCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 185 }, "name": "invocationRateAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 207 }, "name": "isIterator", "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 209 }, "name": "isOffsetLag", "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 212 }, "name": "lambdaInsightsEnabled", "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 175 }, "name": "latencyAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 181 }, "name": "latencyAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 189 }, "name": "maxIteratorAgeAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 208 }, "name": "maxIteratorAgeMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 197 }, "name": "maxLatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 190 }, "name": "maxOffsetLagAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 210 }, "name": "maxOffsetLagMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 188 }, "name": "memoryUsageAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 172 }, "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.LambdaFunctionMetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 171 }, "name": "namingStrategy", "type": { "fqn": "cdk-monitoring-constructs.MonitoringNamingStrategy" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 194 }, "name": "p50LatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 195 }, "name": "p90LatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 196 }, "name": "p99LatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 204 }, "name": "provisionedConcurrencySpilloverInvocationsCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 205 }, "name": "provisionedConcurrencySpilloverInvocationsRateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 177 }, "name": "taskHealthAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.TaskHealthAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 201 }, "name": "throttlesCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 202 }, "name": "throttlesRateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 168 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 176 }, "name": "tpsAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.TpsAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 186 }, "name": "tpsAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 193 }, "name": "tpsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 179 }, "name": "usageAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.UsageAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 213 }, "name": "enhancedMetricFactory", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.LambdaFunctionEnhancedMetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 223 }, "name": "enhancedMetricFunctionCostMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 216 }, "name": "enhancedMonitoringAvgCpuTotalTimeMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 222 }, "name": "enhancedMonitoringAvgInitDurationMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 219 }, "name": "enhancedMonitoringAvgMemoryUtilizationMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 214 }, "name": "enhancedMonitoringMaxCpuTotalTimeMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 220 }, "name": "enhancedMonitoringMaxInitDurationMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 217 }, "name": "enhancedMonitoringMaxMemoryUtilizationMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 215 }, "name": "enhancedMonitoringP90CpuTotalTimeMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 221 }, "name": "enhancedMonitoringP90InitDurationMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 218 }, "name": "enhancedMonitoringP90MemoryUtilizationMetric", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 169 }, "name": "functionUrl", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring:LambdaFunctionMonitoring" }, "cdk-monitoring-constructs.LambdaFunctionMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.LambdaFunctionMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 60 }, "name": "LambdaFunctionMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 104 }, "name": "addConcurrentExecutionsCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.RunningTaskCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 129 }, "name": "addEnhancedMonitoringAvgCpuTotalTimeAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DurationThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 157 }, "name": "addEnhancedMonitoringAvgInitDurationAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DurationThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 143 }, "name": "addEnhancedMonitoringAvgMemoryUtilizationAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 121 }, "name": "addEnhancedMonitoringMaxCpuTotalTimeAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DurationThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 149 }, "name": "addEnhancedMonitoringMaxInitDurationAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DurationThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 135 }, "name": "addEnhancedMonitoringMaxMemoryUtilizationAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 125 }, "name": "addEnhancedMonitoringP90CpuTotalTimeAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DurationThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 153 }, "name": "addEnhancedMonitoringP90InitDurationAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DurationThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 139 }, "name": "addEnhancedMonitoringP90MemoryUtilizationAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 93 }, "name": "addFaultCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 94 }, "name": "addFaultRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 97 }, "name": "addHighTpsAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.HighTpsThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 76 }, "name": "addLatencyP50Alarm", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, { "fqn": "cdk-monitoring-constructs.LatencyTimeoutPercentageThreshold" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 80 }, "name": "addLatencyP90Alarm", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, { "fqn": "cdk-monitoring-constructs.LatencyTimeoutPercentageThreshold" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 84 }, "name": "addLatencyP99Alarm", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, { "fqn": "cdk-monitoring-constructs.LatencyTimeoutPercentageThreshold" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 96 }, "name": "addLowTpsAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LowTpsThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 116 }, "name": "addMaxIteratorAgeAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MaxAgeThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 88 }, "name": "addMaxLatencyAlarm", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, { "fqn": "cdk-monitoring-constructs.LatencyTimeoutPercentageThreshold" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 118 }, "name": "addMaxOffsetLagAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MaxOffsetLagThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 102 }, "name": "addMinInvocationsCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MinUsageCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 108 }, "name": "addProvisionedConcurrencySpilloverInvocationsCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.RunningTaskCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 112 }, "name": "addProvisionedConcurrencySpilloverInvocationsRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.RunningTaskRateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 99 }, "name": "addThrottlesCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 100 }, "name": "addThrottlesRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- true", "stability": "experimental", "summary": "Indicates that the Lambda function handles an event source (e.g. DynamoDB event stream). This impacts what widgets are shown, as well as validates the ability to use addMaxIteratorAgeAlarm." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 67 }, "name": "isIterator", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- false", "stability": "experimental", "summary": "Indicates that the Lambda function handles an event source which uses offsets for records (e.g. Kafka streams). This impacts what widgets are shown, as well as validates the ability to use addMaxOffsetLagAlarm." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 74 }, "name": "isOffsetLag", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring:LambdaFunctionMonitoringOptions" }, "cdk-monitoring-constructs.LambdaFunctionMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.LambdaFunctionMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.LambdaFunctionMetricFactoryProps", "cdk-monitoring-constructs.LambdaFunctionMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 163 }, "name": "LambdaFunctionMonitoringProps", "symbolId": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring:LambdaFunctionMonitoringProps" }, "cdk-monitoring-constructs.LatencyAlarmFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/LatencyAlarmFactory.ts", "line": 151 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/LatencyAlarmFactory.ts", "line": 148 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/LatencyAlarmFactory.ts", "line": 249 }, "name": "addCustomDurationAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.DurationThreshold" } }, { "name": "durationName", "type": { "primitive": "string" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } }, { "name": "additionalAlarmNameSuffix", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/LatencyAlarmFactory.ts", "line": 219 }, "name": "addDurationAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.DurationThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } }, { "name": "additionalAlarmNameSuffix", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/LatencyAlarmFactory.ts", "line": 185 }, "name": "addIntegrationLatencyAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } }, { "name": "additionalAlarmNameSuffix", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/LatencyAlarmFactory.ts", "line": 284 }, "name": "addJvmGarbageCollectionDurationAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.DurationThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } }, { "name": "additionalAlarmNameSuffix", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/LatencyAlarmFactory.ts", "line": 155 }, "name": "addLatencyAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } }, { "name": "additionalAlarmNameSuffix", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } } ], "name": "LatencyAlarmFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/LatencyAlarmFactory.ts", "line": 149 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ], "symbolId": "lib/common/monitoring/alarms/LatencyAlarmFactory:LatencyAlarmFactory" }, "cdk-monitoring-constructs.LatencyThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.LatencyThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/LatencyAlarmFactory.ts", "line": 135 }, "name": "LatencyThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/LatencyAlarmFactory.ts", "line": 136 }, "name": "maxLatency", "type": { "fqn": "aws-cdk-lib.Duration" } } ], "symbolId": "lib/common/monitoring/alarms/LatencyAlarmFactory:LatencyThreshold" }, "cdk-monitoring-constructs.LatencyTimeoutPercentageThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.LatencyTimeoutPercentageThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/LatencyAlarmFactory.ts", "line": 139 }, "name": "LatencyTimeoutPercentageThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/LatencyAlarmFactory.ts", "line": 141 }, "name": "maxLatencyPercentageOfTimeout", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/LatencyAlarmFactory:LatencyTimeoutPercentageThreshold" }, "cdk-monitoring-constructs.LatencyType": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.LatencyType", "kind": "enum", "locationInModule": { "filename": "lib/common/monitoring/alarms/LatencyAlarmFactory.ts", "line": 10 }, "members": [ { "docs": { "stability": "experimental" }, "name": "P50" }, { "docs": { "stability": "experimental" }, "name": "P70" }, { "docs": { "stability": "experimental" }, "name": "P90" }, { "docs": { "stability": "experimental" }, "name": "P95" }, { "docs": { "stability": "experimental" }, "name": "P99" }, { "docs": { "stability": "experimental" }, "name": "P999" }, { "docs": { "stability": "experimental" }, "name": "P9999" }, { "docs": { "stability": "experimental" }, "name": "P100" }, { "docs": { "stability": "experimental" }, "name": "TM50" }, { "docs": { "stability": "experimental" }, "name": "TM70" }, { "docs": { "stability": "experimental" }, "name": "TM90" }, { "docs": { "stability": "experimental" }, "name": "TM95" }, { "docs": { "stability": "experimental" }, "name": "TM99" }, { "docs": { "stability": "experimental" }, "name": "TM999" }, { "docs": { "stability": "experimental" }, "name": "TM9999" }, { "docs": { "stability": "experimental" }, "name": "TM95_TOP" }, { "docs": { "stability": "experimental" }, "name": "TM99_TOP" }, { "docs": { "stability": "experimental" }, "name": "TM999_TOP" }, { "docs": { "stability": "experimental" }, "name": "TM9999_TOP" }, { "docs": { "stability": "experimental" }, "name": "AVERAGE" }, { "docs": { "stability": "experimental" }, "name": "MAX" } ], "name": "LatencyType", "symbolId": "lib/common/monitoring/alarms/LatencyAlarmFactory:LatencyType" }, "cdk-monitoring-constructs.LoadBalancedFargateServiceAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.LoadBalancedFargateServiceAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 101 }, "name": "LoadBalancedFargateServiceAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 103 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.BaseLoadBalancedFargateServiceMonitoringProps" } } ], "symbolId": "lib/facade/IMonitoringAspect:LoadBalancedFargateServiceAspectType" }, "cdk-monitoring-constructs.LogLevel": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental", "summary": "Level of a given log." }, "fqn": "cdk-monitoring-constructs.LogLevel", "kind": "enum", "locationInModule": { "filename": "lib/common/monitoring/alarms/LogLevelAlarmFactory.ts", "line": 12 }, "members": [ { "docs": { "stability": "experimental" }, "name": "ERROR" }, { "docs": { "stability": "experimental" }, "name": "CRITICAL" }, { "docs": { "stability": "experimental" }, "name": "FATAL" } ], "name": "LogLevel", "symbolId": "lib/common/monitoring/alarms/LogLevelAlarmFactory:LogLevel" }, "cdk-monitoring-constructs.LogLevelAlarmFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.LogLevelAlarmFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/LogLevelAlarmFactory.ts", "line": 28 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/LogLevelAlarmFactory.ts", "line": 25 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/LogLevelAlarmFactory.ts", "line": 32 }, "name": "addLogCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "logLevel", "type": { "fqn": "cdk-monitoring-constructs.LogLevel" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.LogLevelCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } } ], "name": "LogLevelAlarmFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/LogLevelAlarmFactory.ts", "line": 26 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ], "symbolId": "lib/common/monitoring/alarms/LogLevelAlarmFactory:LogLevelAlarmFactory" }, "cdk-monitoring-constructs.LogLevelCountThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.LogLevelCountThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/LogLevelAlarmFactory.ts", "line": 18 }, "name": "LogLevelCountThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Threshold for the number of logs to alarm on." }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/LogLevelAlarmFactory.ts", "line": 22 }, "name": "maxLogCount", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/LogLevelAlarmFactory:LogLevelCountThreshold" }, "cdk-monitoring-constructs.LogMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental", "summary": "Monitors a CloudWatch log group for various patterns." }, "fqn": "cdk-monitoring-constructs.LogMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 91 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.LogMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 75 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 210 }, "name": "createIncomingLogsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 202 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 221 }, "name": "resolveRecommendedHeight", "parameters": [ { "name": "numRows", "type": { "primitive": "number" } } ], "protected": true, "returns": { "type": { "primitive": "number" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 147 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 154 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "LogMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 85 }, "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 87 }, "name": "incomingLogEventsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 83 }, "name": "limit", "type": { "primitive": "number" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 76 }, "name": "logGroupName", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 86 }, "name": "usageAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.UsageAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 89 }, "name": "usageAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 82 }, "name": "filterExpressions", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 77 }, "name": "logGroupUrl", "optional": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 81 }, "name": "pattern", "optional": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 79 }, "name": "title", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-cloudwatch/LogMonitoring:LogMonitoring" }, "cdk-monitoring-constructs.LogMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.LogMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps", "cdk-monitoring-constructs.CloudWatchLogsMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 36 }, "name": "LogMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 69 }, "name": "addMaxIncomingLogsAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MaxUsageCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 68 }, "name": "addMinIncomingLogsAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MinUsageCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "example": "filterExpressions = [`level = \"ERROR\"`]\n// will be appended to the query as\n| filter level = \"ERROR\"", "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax-Filter.html", "stability": "experimental", "summary": "Filter expressions to add." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 59 }, "name": "filterExpressions", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- 10", "stability": "experimental", "summary": "Maximum number of log messages to search for." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 66 }, "name": "limit", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Pattern to filter `@message` field, e.g. \"ERROR\"." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 49 }, "name": "pattern", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- auto-generated title based on the pattern and limit", "stability": "experimental", "summary": "Widget title." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 44 }, "name": "title", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-cloudwatch/LogMonitoring:LogMonitoringProps" }, "cdk-monitoring-constructs.LowConnectionCountThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.LowConnectionCountThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/ConnectionAlarmFactory.ts", "line": 9 }, "name": "LowConnectionCountThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/ConnectionAlarmFactory.ts", "line": 10 }, "name": "minConnectionCount", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/ConnectionAlarmFactory:LowConnectionCountThreshold" }, "cdk-monitoring-constructs.LowMessagesPublishedThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.LowMessagesPublishedThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/TopicAlarmFactory.ts", "line": 9 }, "name": "LowMessagesPublishedThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/TopicAlarmFactory.ts", "line": 10 }, "name": "minMessagesPublishedCount", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/TopicAlarmFactory:LowMessagesPublishedThreshold" }, "cdk-monitoring-constructs.LowTpsThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.LowTpsThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/TpsAlarmFactory.ts", "line": 9 }, "name": "LowTpsThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/TpsAlarmFactory.ts", "line": 10 }, "name": "minTps", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/TpsAlarmFactory:LowTpsThreshold" }, "cdk-monitoring-constructs.MaxAgeThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MaxAgeThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/AgeAlarmFactory.ts", "line": 13 }, "name": "MaxAgeThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/AgeAlarmFactory.ts", "line": 14 }, "name": "maxAgeInMillis", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/AgeAlarmFactory:MaxAgeThreshold" }, "cdk-monitoring-constructs.MaxBackPressuredTimeMsPerSecondThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MaxBackPressuredTimeMsPerSecondThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory.ts", "line": 23 }, "name": "MaxBackPressuredTimeMsPerSecondThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory.ts", "line": 25 }, "name": "maxBackPressuredTimeMsPerSecond", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory:MaxBackPressuredTimeMsPerSecondThreshold" }, "cdk-monitoring-constructs.MaxDowntimeThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MaxDowntimeThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory.ts", "line": 15 }, "name": "MaxDowntimeThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory.ts", "line": 16 }, "name": "maxDowntimeInMillis", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory:MaxDowntimeThreshold" }, "cdk-monitoring-constructs.MaxIncomingMessagesCountThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MaxIncomingMessagesCountThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/QueueAlarmFactory.ts", "line": 31 }, "name": "MaxIncomingMessagesCountThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/QueueAlarmFactory.ts", "line": 33 }, "name": "maxIncomingMessagesCount", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/QueueAlarmFactory:MaxIncomingMessagesCountThreshold" }, "cdk-monitoring-constructs.MaxItemsCountThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MaxItemsCountThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory.ts", "line": 9 }, "name": "MaxItemsCountThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory.ts", "line": 10 }, "name": "maxItemsCount", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory:MaxItemsCountThreshold" }, "cdk-monitoring-constructs.MaxIteratorAgeThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MaxIteratorAgeThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 9 }, "name": "MaxIteratorAgeThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 10 }, "name": "maxAgeInMillis", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/KinesisAlarmFactory:MaxIteratorAgeThreshold" }, "cdk-monitoring-constructs.MaxMessageAgeThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MaxMessageAgeThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/QueueAlarmFactory.ts", "line": 18 }, "name": "MaxMessageAgeThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/QueueAlarmFactory.ts", "line": 19 }, "name": "maxAgeInSeconds", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/QueueAlarmFactory:MaxMessageAgeThreshold" }, "cdk-monitoring-constructs.MaxMessageCountThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MaxMessageCountThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/QueueAlarmFactory.ts", "line": 14 }, "name": "MaxMessageCountThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/QueueAlarmFactory.ts", "line": 15 }, "name": "maxMessageCount", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/QueueAlarmFactory:MaxMessageCountThreshold" }, "cdk-monitoring-constructs.MaxOffsetLagThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MaxOffsetLagThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/AgeAlarmFactory.ts", "line": 17 }, "name": "MaxOffsetLagThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/AgeAlarmFactory.ts", "line": 18 }, "name": "maxOffsetLag", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/AgeAlarmFactory:MaxOffsetLagThreshold" }, "cdk-monitoring-constructs.MaxSecretCountThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MaxSecretCountThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/SecretsManagerAlarmFactory.ts", "line": 15 }, "name": "MaxSecretCountThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/SecretsManagerAlarmFactory.ts", "line": 16 }, "name": "maxSecretCount", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/SecretsManagerAlarmFactory:MaxSecretCountThreshold" }, "cdk-monitoring-constructs.MaxThrottleRateThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MaxThrottleRateThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory.ts", "line": 17 }, "name": "MaxThrottleRateThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory.ts", "line": 18 }, "name": "maxThrottleRatePercent", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory:MaxThrottleRateThreshold" }, "cdk-monitoring-constructs.MaxTimeToDrainThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MaxTimeToDrainThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/QueueAlarmFactory.ts", "line": 22 }, "name": "MaxTimeToDrainThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/QueueAlarmFactory.ts", "line": 23 }, "name": "maxTimeToDrain", "type": { "fqn": "aws-cdk-lib.Duration" } } ], "symbolId": "lib/common/monitoring/alarms/QueueAlarmFactory:MaxTimeToDrainThreshold" }, "cdk-monitoring-constructs.MaxUsageCountThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MaxUsageCountThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 29 }, "name": "MaxUsageCountThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 30 }, "name": "maxCount", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/UsageAlarmFactory:MaxUsageCountThreshold" }, "cdk-monitoring-constructs.MaxUsedSwapMemoryThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MaxUsedSwapMemoryThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory.ts", "line": 25 }, "name": "MaxUsedSwapMemoryThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory.ts", "line": 26 }, "name": "maxUsedSwapMemoryInBytes", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory:MaxUsedSwapMemoryThreshold" }, "cdk-monitoring-constructs.MetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 48 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 44 }, "methods": [ { "docs": { "remarks": "Might modify namespace and metric period.", "stability": "experimental", "summary": "Adapts properties of a foreign metric (metric created outside of this metric factory) to comply with the global defaults." }, "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 235 }, "name": "adaptMetric", "parameters": [ { "docs": { "summary": "metric to be adapted." }, "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "remarks": "Might modify namespace. Preserves metric period.", "stability": "experimental", "summary": "Adapts properties of a foreign metric (metric created outside of this metric factory) to comply with the global defaults." }, "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 255 }, "name": "adaptMetricPreservingPeriod", "parameters": [ { "docs": { "summary": "metric to be adapted." }, "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "remarks": "All existing dimensions with the same key are replaced.", "stability": "experimental", "summary": "Merges the given additional dimensions to the given target dimension hash." }, "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 456 }, "name": "addAdditionalDimensions", "parameters": [ { "docs": { "summary": "target dimension hash to update." }, "name": "target", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "summary": "additional dimensions." }, "name": "additionalDimensions", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } } ] }, { "docs": { "remarks": "The metric properties will already be updated to comply with the global defaults.", "stability": "experimental", "summary": "Factory method that creates a metric." }, "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 66 }, "name": "createMetric", "parameters": [ { "docs": { "summary": "metric name." }, "name": "metricName", "type": { "primitive": "string" } }, { "docs": { "summary": "aggregation statistic to use." }, "name": "statistic", "type": { "fqn": "cdk-monitoring-constructs.MetricStatistic" } }, { "docs": { "remarks": "if undefined, metric name is used by CloudWatch", "summary": "metric label;" }, "name": "label", "optional": true, "type": { "primitive": "string" } }, { "docs": { "summary": "additional dimensions to be added." }, "name": "dimensionsMap", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "remarks": "if undefined, uses a CloudWatch provided color (preferred)", "summary": "metric color;" }, "name": "color", "optional": true, "type": { "primitive": "string" } }, { "docs": { "remarks": "if undefined, uses the global default", "summary": "specify a custom namespace;" }, "name": "namespace", "optional": true, "type": { "primitive": "string" } }, { "docs": { "remarks": "if undefined, uses the global default", "summary": "specify a custom period;" }, "name": "period", "optional": true, "type": { "fqn": "aws-cdk-lib.Duration" } }, { "docs": { "remarks": "if undefined, uses the global default", "summary": "specify a custom region;" }, "name": "region", "optional": true, "type": { "primitive": "string" } }, { "docs": { "remarks": "if undefined, uses the global default", "summary": "specify a custom account;" }, "name": "account", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "remarks": "Anomaly occurs whenever a metric value falls outside of a precomputed range of predicted values.\nThe detection does not need any setup. The model will start learning automatically and should be ready in a few minutes.\nUsually, the anomaly detection is paired with an alarm.", "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Anomaly_Detection.html", "stability": "experimental", "summary": "Factory method that creates anomaly detection on a metric." }, "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 203 }, "name": "createMetricAnomalyDetection", "parameters": [ { "docs": { "summary": "metric to detect anomaly detection of." }, "name": "metric", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" } }, { "docs": { "summary": "standard deviation, basically the tolerance / band thickness." }, "name": "stdev", "type": { "primitive": "number" } }, { "docs": { "summary": "metric label (required, as there is no reasonable default)." }, "name": "label", "type": { "primitive": "string" } }, { "docs": { "remarks": "if undefined, uses a CloudWatch provided color (preferred)", "summary": "metric color;" }, "name": "color", "optional": true, "type": { "primitive": "string" } }, { "docs": { "remarks": "uses `m1` if undefined", "summary": "expression ID of the metric;" }, "name": "expressionId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "remarks": "if undefined, uses the global default", "summary": "specify a custom period;" }, "name": "period", "optional": true, "type": { "fqn": "aws-cdk-lib.Duration" } }, { "docs": { "remarks": "if undefined, uses the global default", "summary": "specify a custom region;" }, "name": "region", "optional": true, "type": { "primitive": "string" } }, { "docs": { "remarks": "if undefined, uses the global default", "summary": "specify a custom account;" }, "name": "account", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "remarks": "The metric properties will already be updated to comply with the global defaults.", "stability": "experimental", "summary": "Factory method that creates a metric math expression." }, "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 103 }, "name": "createMetricMath", "parameters": [ { "docs": { "summary": "CloudWatch metric math expression (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html)." }, "name": "expression", "type": { "primitive": "string" } }, { "docs": { "summary": "map of metrics, where keys are expression IDs (used in the expression) and values are metrics." }, "name": "usingMetrics", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" }, "kind": "map" } } }, { "docs": { "summary": "metric label (required, as there is no reasonable default)." }, "name": "label", "type": { "primitive": "string" } }, { "docs": { "remarks": "if undefined, uses a CloudWatch provided color (preferred)", "summary": "metric color;" }, "name": "color", "optional": true, "type": { "primitive": "string" } }, { "docs": { "remarks": "if undefined, uses the global default", "summary": "specify a custom period;" }, "name": "period", "optional": true, "type": { "fqn": "aws-cdk-lib.Duration" } }, { "docs": { "summary": "-- Deprecated: Use createSearchMetric if doing cross region search." }, "name": "region", "optional": true, "type": { "primitive": "string" } }, { "docs": { "summary": "-- Deprecated: Use createSearchMetric if doing cross region search." }, "name": "account", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "remarks": "The metric properties will already be updated to comply with the global defaults.\nIf you want to match \"any value\" of a specific dimension, please use `undefined` value representation in your consumer language.\n(For example, `undefined as any as string` in TypeScript, due to JSII typing quirks.)", "stability": "experimental", "summary": "Factory method that creates a metric search query." }, "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 140 }, "name": "createMetricSearch", "parameters": [ { "docs": { "summary": "metric search query (the same as the search query prompt in CloudWatch AWS Console), it might also be empty." }, "name": "query", "type": { "primitive": "string" } }, { "docs": { "remarks": "use `undefined` if you want to represent \"any value\" (in TS: `undefined as any as string`)", "summary": "dimensions, further narrowing the search results;" }, "name": "dimensionsMap", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "summary": "aggregation statistic to use." }, "name": "statistic", "type": { "fqn": "cdk-monitoring-constructs.MetricStatistic" } }, { "docs": { "remarks": "if undefined, uses the global default", "summary": "specify a custom namespace;" }, "name": "namespace", "optional": true, "type": { "primitive": "string" } }, { "docs": { "remarks": "default is \" \" as it cannot be empty string", "summary": "specify custom label for search metrics;" }, "name": "label", "optional": true, "type": { "primitive": "string" } }, { "docs": { "remarks": "if undefined, uses the global default", "summary": "specify a custom period;" }, "name": "period", "optional": true, "type": { "fqn": "aws-cdk-lib.Duration" } }, { "docs": { "remarks": "if undefined, uses the global default", "summary": "specify a custom region;" }, "name": "region", "optional": true, "type": { "primitive": "string" } }, { "docs": { "remarks": "if undefined, uses the global default", "summary": "specify a custom account;" }, "name": "account", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } } }, { "docs": { "remarks": "Does nothing if the divisor is one. Preserves the metric period.", "stability": "experimental", "summary": "Creates a metric math expression that divides the given metric by given coefficient." }, "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 303 }, "name": "divideMetric", "parameters": [ { "docs": { "summary": "metric to multiply." }, "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "summary": "divisor (must be > 1)." }, "name": "divisor", "type": { "primitive": "number" } }, { "docs": { "summary": "expression label." }, "name": "label", "type": { "primitive": "string" } }, { "docs": { "remarks": "uses `m1` if undefined", "summary": "expression ID of the metric;" }, "name": "expressionId", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "remarks": "If there is no namespace to fallback to (neither the custom or the default one), it will fail.", "stability": "experimental", "summary": "Returns the given namespace (if defined) or the global namespace as a fallback." }, "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 430 }, "name": "getNamespaceWithFallback", "parameters": [ { "docs": { "summary": "custom namespace." }, "name": "value", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } } }, { "docs": { "remarks": "Does nothing if the multiplier is one. Preserves the metric period.", "stability": "experimental", "summary": "Creates a metric math expression that multiplies the given metric by given coefficient." }, "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 270 }, "name": "multiplyMetric", "parameters": [ { "docs": { "summary": "metric to multiply." }, "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "summary": "multiplier (must be > 1)." }, "name": "multiplier", "type": { "primitive": "number" } }, { "docs": { "summary": "expression label." }, "name": "label", "type": { "primitive": "string" } }, { "docs": { "remarks": "uses `m1` if undefined", "summary": "expression ID of the metric;" }, "name": "expressionId", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "remarks": "Valid expression ID regexp is the following: ^[a-z][a-zA-Z0-9_]*$\nAs this is just to validate a suffix and not the whole ID, we do not have to verify the first lower case letter.", "stability": "experimental", "summary": "Helper method that helps to sanitize the given expression ID and removes all invalid characters." }, "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 446 }, "name": "sanitizeMetricExpressionIdSuffix", "parameters": [ { "docs": { "summary": "expression ID to sanitize." }, "name": "expressionId", "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } } }, { "docs": { "remarks": "For example, it allows you to compute rate per second (TPS), per minute, or just an average of your transactions.", "stability": "experimental", "summary": "Creates a metric math expression that computes a rate from a regular metric." }, "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 337 }, "name": "toRate", "parameters": [ { "docs": { "summary": "metric to calculate the rate from." }, "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "summary": "rate computation method." }, "name": "method", "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } }, { "docs": { "summary": "add detailed statistics (min, max, average) to the label." }, "name": "addStatsToLabel", "optional": true, "type": { "primitive": "boolean" } }, { "docs": { "remarks": "uses `m1` if undefined", "summary": "expression ID of the metric;" }, "name": "expressionId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "remarks": "false if undefined", "summary": "if TRUE, the final metric will be zero-filled (0 on no data);" }, "name": "fillWithZeroes", "optional": true, "type": { "primitive": "boolean" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "MetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 45 }, "name": "globalDefaults", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactoryDefaults" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 46 }, "name": "scope", "optional": true, "protected": true, "type": { "fqn": "constructs.Construct" } } ], "symbolId": "lib/common/metric/MetricFactory:MetricFactory" }, "cdk-monitoring-constructs.MetricFactoryDefaults": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "These are the globals used for each metric, unless there is some kind of override." }, "fqn": "cdk-monitoring-constructs.MetricFactoryDefaults", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 24 }, "name": "MetricFactoryDefaults", "properties": [ { "abstract": true, "docs": { "remarks": "AWS Services have their own namespace, but here you can specify your custom one.", "stability": "experimental", "summary": "Each metric exists in a namespace." }, "immutable": true, "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 28 }, "name": "namespace", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- DefaultMetricPeriod", "remarks": "Default value is used if not defined.", "stability": "experimental", "summary": "Metric period." }, "immutable": true, "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 34 }, "name": "period", "optional": true, "type": { "fqn": "aws-cdk-lib.Duration" } } ], "symbolId": "lib/common/metric/MetricFactory:MetricFactoryDefaults" }, "cdk-monitoring-constructs.MetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MetricFactoryProps", "kind": "interface", "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 37 }, "name": "MetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Allows you to specify the global defaults, which can be overridden in the individual metrics or alarms." }, "immutable": true, "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 41 }, "name": "globalDefaults", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactoryDefaults" } } ], "symbolId": "lib/common/metric/MetricFactory:MetricFactoryProps" }, "cdk-monitoring-constructs.MetricStatistic": { "assembly": "cdk-monitoring-constructs", "docs": { "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html", "stability": "experimental", "summary": "Metric aggregation statistic to be used with the IMetric objects." }, "fqn": "cdk-monitoring-constructs.MetricStatistic", "kind": "enum", "locationInModule": { "filename": "lib/common/metric/MetricStatistic.ts", "line": 6 }, "members": [ { "docs": { "stability": "experimental", "summary": "50th percentile of all datapoints." }, "name": "P50" }, { "docs": { "stability": "experimental", "summary": "70th percentile of all datapoints." }, "name": "P70" }, { "docs": { "stability": "experimental", "summary": "90th percentile of all datapoints." }, "name": "P90" }, { "docs": { "stability": "experimental", "summary": "95th percentile of all datapoints." }, "name": "P95" }, { "docs": { "stability": "experimental", "summary": "99th percentile of all datapoints." }, "name": "P99" }, { "docs": { "stability": "experimental", "summary": "99.9th percentile of all datapoints." }, "name": "P999" }, { "docs": { "stability": "experimental", "summary": "99.99th percentile of all datapoints." }, "name": "P9999" }, { "docs": { "stability": "experimental", "summary": "100th percentile of all datapoints." }, "name": "P100" }, { "docs": { "remarks": "calculates the average after removing the 50% of data points with the highest values", "stability": "experimental", "summary": "trimmed mean;" }, "name": "TM50" }, { "docs": { "remarks": "calculates the average after removing the 30% of data points with the highest values", "stability": "experimental", "summary": "trimmed mean;" }, "name": "TM70" }, { "docs": { "remarks": "calculates the average after removing the 10% of data points with the highest values", "stability": "experimental", "summary": "trimmed mean;" }, "name": "TM90" }, { "docs": { "remarks": "calculates the average after removing the 5% of data points with the highest values", "stability": "experimental", "summary": "trimmed mean;" }, "name": "TM95" }, { "docs": { "remarks": "calculates the average after removing the 1% of data points with the highest values", "stability": "experimental", "summary": "trimmed mean;" }, "name": "TM99" }, { "docs": { "remarks": "calculates the average after removing the 0.1% of data points with the highest values", "stability": "experimental", "summary": "trimmed mean;" }, "name": "TM999" }, { "docs": { "remarks": "calculates the average after removing the 0.01% of data points with the highest values", "stability": "experimental", "summary": "trimmed mean;" }, "name": "TM9999" }, { "docs": { "remarks": "calculates the average after removing the 1% lowest data points and the 1% highest data points", "stability": "experimental", "summary": "trimmed mean;" }, "name": "TM99_BOTH" }, { "docs": { "remarks": "calculates the average after removing the 5% lowest data points and the 5% highest data points", "stability": "experimental", "summary": "trimmed mean;" }, "name": "TM95_BOTH" }, { "docs": { "remarks": "calculates the average after removing the 10% lowest data points and the 10% highest data points", "stability": "experimental", "summary": "trimmed mean;" }, "name": "TM90_BOTH" }, { "docs": { "remarks": "calculates the average after removing the 15% lowest data points and the 15% highest data points", "stability": "experimental", "summary": "trimmed mean;" }, "name": "TM85_BOTH" }, { "docs": { "remarks": "calculates the average after removing the 20% lowest data points and the 20% highest data points", "stability": "experimental", "summary": "trimmed mean;" }, "name": "TM80_BOTH" }, { "docs": { "remarks": "calculates the average after removing the 25% lowest data points and the 25% highest data points", "stability": "experimental", "summary": "trimmed mean;" }, "name": "TM75_BOTH" }, { "docs": { "remarks": "calculates the average after removing the 30% lowest data points and the 30% highest data points", "stability": "experimental", "summary": "trimmed mean;" }, "name": "TM70_BOTH" }, { "docs": { "remarks": "calculates the average after removing the 95% lowest data points", "stability": "experimental", "summary": "trimmed mean;" }, "name": "TM95_TOP" }, { "docs": { "remarks": "calculates the average after removing the 99% lowest data points", "stability": "experimental", "summary": "trimmed mean;" }, "name": "TM99_TOP" }, { "docs": { "remarks": "calculates the average after removing the 99.9% lowest data points", "stability": "experimental", "summary": "trimmed mean;" }, "name": "TM999_TOP" }, { "docs": { "remarks": "calculates the average after removing the 99.99% lowest data points", "stability": "experimental", "summary": "trimmed mean;" }, "name": "TM9999_TOP" }, { "docs": { "remarks": "calculates the sum after removing the 50% of data points with the highest values", "stability": "experimental", "summary": "trimmed sum;" }, "name": "TS50" }, { "docs": { "remarks": "calculates the sum after removing the 30% of data points with the highest values", "stability": "experimental", "summary": "trimmed sum;" }, "name": "TS70" }, { "docs": { "remarks": "calculates the sum after removing the 10% of data points with the highest values", "stability": "experimental", "summary": "trimmed sum;" }, "name": "TS90" }, { "docs": { "remarks": "calculates the sum after removing the 5% of data points with the highest values", "stability": "experimental", "summary": "trimmed sum;" }, "name": "TS95" }, { "docs": { "remarks": "calculates the sum after removing the 1% of data points with the highest values", "stability": "experimental", "summary": "trimmed sum;" }, "name": "TS99" }, { "docs": { "remarks": "calculates the sum after removing the 0.1% of data points with the highest values", "stability": "experimental", "summary": "trimmed sum;" }, "name": "TS999" }, { "docs": { "remarks": "calculates the sum after removing the 0.01% of data points with the highest values", "stability": "experimental", "summary": "trimmed sum;" }, "name": "TS9999" }, { "docs": { "remarks": "calculates the sum after removing the 1% lowest data points and the 1% highest data points", "stability": "experimental", "summary": "trimmed sum;" }, "name": "TS99_BOTH" }, { "docs": { "remarks": "calculates the sum after removing the 5% lowest data points and the 5% highest data points", "stability": "experimental", "summary": "trimmed sum;" }, "name": "TS95_BOTH" }, { "docs": { "remarks": "calculates the sum after removing the 10% lowest data points and the 10% highest data points", "stability": "experimental", "summary": "trimmed sum;" }, "name": "TS90_BOTH" }, { "docs": { "remarks": "calculates the sum after removing the 15% lowest data points and the 15% highest data points", "stability": "experimental", "summary": "trimmed sum;" }, "name": "TS85_BOTH" }, { "docs": { "remarks": "calculates the sum after removing the 20% lowest data points and the 20% highest data points", "stability": "experimental", "summary": "trimmed sum;" }, "name": "TS80_BOTH" }, { "docs": { "remarks": "calculates the sum after removing the 25% lowest data points and the 25% highest data points", "stability": "experimental", "summary": "trimmed sum;" }, "name": "TS75_BOTH" }, { "docs": { "remarks": "calculates the sum after removing the 30% lowest data points and the 30% highest data points", "stability": "experimental", "summary": "trimmed sum;" }, "name": "TS70_BOTH" }, { "docs": { "remarks": "calculates the sum after removing the 95% lowest data points", "stability": "experimental", "summary": "trimmed sum;" }, "name": "TS95_TOP" }, { "docs": { "remarks": "calculates the sum after removing the 99% lowest data points", "stability": "experimental", "summary": "trimmed sum;" }, "name": "TS99_TOP" }, { "docs": { "remarks": "calculates the sum after removing the 99.9% lowest data points", "stability": "experimental", "summary": "trimmed sum;" }, "name": "TS999_TOP" }, { "docs": { "remarks": "calculates the sum after removing the 99.99% lowest data points", "stability": "experimental", "summary": "trimmed sum;" }, "name": "TS9999_TOP" }, { "docs": { "remarks": "calculates the average while treating the 50% of the highest values to be equal to the value at the 50th percentile", "stability": "experimental", "summary": "winsorized mean;" }, "name": "WM50" }, { "docs": { "remarks": "calculates the average while treating the 30% of the highest values to be equal to the value at the 70th percentile", "stability": "experimental", "summary": "winsorized mean;" }, "name": "WM70" }, { "docs": { "remarks": "calculates the average while treating the 10% of the highest values to be equal to the value at the 90th percentile", "stability": "experimental", "summary": "winsorized mean;" }, "name": "WM90" }, { "docs": { "remarks": "calculates the average while treating the 5% of the highest values to be equal to the value at the 95th percentile", "stability": "experimental", "summary": "winsorized mean;" }, "name": "WM95" }, { "docs": { "remarks": "calculates the average while treating the 1% of the highest values to be equal to the value at the 99th percentile", "stability": "experimental", "summary": "winsorized mean;" }, "name": "WM99" }, { "docs": { "remarks": "calculates the average while treating the 0.1% of the highest values to be equal to the value at the 99.9th percentile", "stability": "experimental", "summary": "winsorized mean;" }, "name": "WM999" }, { "docs": { "remarks": "calculates the average while treating the 0.01% of the highest values to be equal to the value at the 99.99th percentile", "stability": "experimental", "summary": "winsorized mean;" }, "name": "WM9999" }, { "docs": { "remarks": "calculates the average while treating the highest 1% of data points to be the value of the 99% boundary, and treating the lowest 1% of data points to be the value of the 1% boundary", "stability": "experimental", "summary": "winsorized mean;" }, "name": "WM99_BOTH" }, { "docs": { "remarks": "calculates the average while treating the highest 5% of data points to be the value of the 95% boundary, and treating the lowest 5% of data points to be the value of the 5% boundary", "stability": "experimental", "summary": "winsorized mean;" }, "name": "WM95_BOTH" }, { "docs": { "remarks": "calculates the average while treating the highest 10% of data points to be the value of the 90% boundary, and treating the lowest 10% of data points to be the value of the 10% boundary", "stability": "experimental", "summary": "winsorized mean;" }, "name": "WM90_BOTH" }, { "docs": { "remarks": "calculates the average while treating the highest 15% of data points to be the value of the 85% boundary, and treating the lowest 15% of data points to be the value of the 15% boundary", "stability": "experimental", "summary": "winsorized mean;" }, "name": "WM85_BOTH" }, { "docs": { "remarks": "calculates the average while treating the highest 20% of data points to be the value of the 80% boundary, and treating the lowest 20% of data points to be the value of the 20% boundary", "stability": "experimental", "summary": "winsorized mean;" }, "name": "WM80_BOTH" }, { "docs": { "remarks": "calculates the average while treating the highest 25% of data points to be the value of the 75% boundary, and treating the lowest 25% of data points to be the value of the 25% boundary", "stability": "experimental", "summary": "winsorized mean;" }, "name": "WM75_BOTH" }, { "docs": { "remarks": "calculates the average while treating the highest 30% of data points to be the value of the 70% boundary, and treating the lowest 30% of data points to be the value of the 30% boundary", "stability": "experimental", "summary": "winsorized mean;" }, "name": "WM70_BOTH" }, { "docs": { "stability": "experimental", "summary": "minimum of all datapoints." }, "name": "MIN" }, { "docs": { "stability": "experimental", "summary": "maximum of all datapoints." }, "name": "MAX" }, { "docs": { "stability": "experimental", "summary": "sum of all datapoints." }, "name": "SUM" }, { "docs": { "stability": "experimental", "summary": "average of all datapoints." }, "name": "AVERAGE" }, { "docs": { "stability": "experimental", "summary": "number of datapoints." }, "name": "N" } ], "name": "MetricStatistic", "symbolId": "lib/common/metric/MetricStatistic:MetricStatistic" }, "cdk-monitoring-constructs.MinConsumerSubscribeToShardSuccessThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MinConsumerSubscribeToShardSuccessThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 33 }, "name": "MinConsumerSubscribeToShardSuccessThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Minimum acceptable SubscribeToShard.Success average (0.0–1.0)." }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 36 }, "name": "minSuccessRate", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/KinesisAlarmFactory:MinConsumerSubscribeToShardSuccessThreshold" }, "cdk-monitoring-constructs.MinFreeableMemoryThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MinFreeableMemoryThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory.ts", "line": 21 }, "name": "MinFreeableMemoryThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory.ts", "line": 22 }, "name": "minFreeableMemoryInBytes", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory:MinFreeableMemoryThreshold" }, "cdk-monitoring-constructs.MinHitRateThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MinHitRateThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory.ts", "line": 13 }, "name": "MinHitRateThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory.ts", "line": 14 }, "name": "minHitRatePercent", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory:MinHitRateThreshold" }, "cdk-monitoring-constructs.MinIncomingMessagesCountThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MinIncomingMessagesCountThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/QueueAlarmFactory.ts", "line": 26 }, "name": "MinIncomingMessagesCountThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/QueueAlarmFactory.ts", "line": 28 }, "name": "minIncomingMessagesCount", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/QueueAlarmFactory:MinIncomingMessagesCountThreshold" }, "cdk-monitoring-constructs.MinMessageCountThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MinMessageCountThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/QueueAlarmFactory.ts", "line": 10 }, "name": "MinMessageCountThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/QueueAlarmFactory.ts", "line": 11 }, "name": "minMessageCount", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/QueueAlarmFactory:MinMessageCountThreshold" }, "cdk-monitoring-constructs.MinProcessedBytesThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MinProcessedBytesThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/ThroughputAlarmFactory.ts", "line": 9 }, "name": "MinProcessedBytesThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Threshold for the least number of bytes processed." }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/ThroughputAlarmFactory.ts", "line": 13 }, "name": "minProcessedBytes", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/ThroughputAlarmFactory:MinProcessedBytesThreshold" }, "cdk-monitoring-constructs.MinRunningTaskCountThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MinRunningTaskCountThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 29 }, "name": "MinRunningTaskCountThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 30 }, "name": "minRunningTasks", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/TaskHealthAlarmFactory:MinRunningTaskCountThreshold" }, "cdk-monitoring-constructs.MinSecretCountThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MinSecretCountThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/SecretsManagerAlarmFactory.ts", "line": 11 }, "name": "MinSecretCountThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/SecretsManagerAlarmFactory.ts", "line": 12 }, "name": "minSecretCount", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/SecretsManagerAlarmFactory:MinSecretCountThreshold" }, "cdk-monitoring-constructs.MinUsageCountThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MinUsageCountThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 25 }, "name": "MinUsageCountThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 26 }, "name": "minCount", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/UsageAlarmFactory:MinUsageCountThreshold" }, "cdk-monitoring-constructs.Monitoring": { "abstract": true, "assembly": "cdk-monitoring-constructs", "docs": { "remarks": "This is the base for all monitoring classes with alarm support.", "stability": "experimental", "summary": "An independent unit of monitoring." }, "fqn": "cdk-monitoring-constructs.Monitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/Monitoring.ts", "line": 42 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.BaseMonitoringProps" } } ], "protected": true }, "interfaces": [ "cdk-monitoring-constructs.IDashboardSegment", "cdk-monitoring-constructs.IDynamicDashboardSegment" ], "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/Monitoring.ts", "line": 35 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Adds an alarm." }, "locationInModule": { "filename": "lib/common/monitoring/Monitoring.ts", "line": 77 }, "name": "addAlarm", "parameters": [ { "docs": { "summary": "alarm to add." }, "name": "alarm", "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } ] }, { "docs": { "remarks": "These can go to runbook or to service dashboard.", "stability": "experimental", "summary": "Returns widgets for all alarms." }, "locationInModule": { "filename": "lib/common/monitoring/Monitoring.ts", "line": 91 }, "name": "alarmWidgets", "overrides": "cdk-monitoring-constructs.IDashboardSegment", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "remarks": "Alarms created will be named with the given prefix, unless a local name override is present.", "stability": "experimental", "summary": "Creates a new alarm factory." }, "locationInModule": { "filename": "lib/common/monitoring/Monitoring.ts", "line": 67 }, "name": "createAlarmFactory", "parameters": [ { "docs": { "summary": "alarm name prefix." }, "name": "alarmNamePrefix", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } }, { "docs": { "stability": "experimental", "summary": "Returns all the alarms created." }, "locationInModule": { "filename": "lib/common/monitoring/Monitoring.ts", "line": 84 }, "name": "createdAlarms", "returns": { "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Creates a new metric factory." }, "locationInModule": { "filename": "lib/common/monitoring/Monitoring.ts", "line": 58 }, "name": "createMetricFactory", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } } }, { "docs": { "stability": "experimental", "summary": "Creates a new widget factory." }, "locationInModule": { "filename": "lib/common/monitoring/Monitoring.ts", "line": 51 }, "name": "createWidgetFactory", "returns": { "type": { "fqn": "cdk-monitoring-constructs.IWidgetFactory" } } }, { "docs": { "default": "- no widgets.", "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/common/monitoring/Monitoring.ts", "line": 102 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.IDashboardSegment", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/common/monitoring/Monitoring.ts", "line": 109 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.IDashboardSegment", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets for the requested dashboard type." }, "locationInModule": { "filename": "lib/common/monitoring/Monitoring.ts", "line": 111 }, "name": "widgetsForDashboard", "overrides": "cdk-monitoring-constructs.IDynamicDashboardSegment", "parameters": [ { "name": "name", "type": { "primitive": "string" } } ], "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "Monitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/Monitoring.ts", "line": 39 }, "name": "alarms", "protected": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/Monitoring.ts", "line": 38 }, "name": "scope", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/Monitoring.ts", "line": 40 }, "name": "localAlarmNamePrefixOverride", "optional": true, "protected": true, "type": { "primitive": "string" } } ], "symbolId": "lib/common/monitoring/Monitoring:Monitoring" }, "cdk-monitoring-constructs.MonitoringAspect": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental", "summary": "A CDK aspect that adds support for monitoring all resources within scope." }, "fqn": "cdk-monitoring-constructs.MonitoringAspect", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringAspect.ts", "line": 47 }, "parameters": [ { "name": "monitoringFacade", "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } }, { "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectProps" } } ] }, "interfaces": [ "aws-cdk-lib.IAspect" ], "kind": "class", "locationInModule": { "filename": "lib/facade/MonitoringAspect.ts", "line": 41 }, "methods": [ { "docs": { "stability": "experimental", "summary": "All aspects can visit an IConstruct." }, "locationInModule": { "filename": "lib/facade/MonitoringAspect.ts", "line": 52 }, "name": "visit", "overrides": "aws-cdk-lib.IAspect", "parameters": [ { "name": "node", "type": { "fqn": "constructs.IConstruct" } } ] } ], "name": "MonitoringAspect", "symbolId": "lib/facade/MonitoringAspect:MonitoringAspect" }, "cdk-monitoring-constructs.MonitoringAspectProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MonitoringAspectProps", "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 182 }, "name": "MonitoringAspectProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 183 }, "name": "acm", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.CertificateManagerAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 184 }, "name": "apiGateway", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.ApiGatewayAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 185 }, "name": "apiGatewayV2", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.ApiGatewayV2AspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 186 }, "name": "appSync", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.AppSyncAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 187 }, "name": "auroraCluster", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.AuroraClusterAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 188 }, "name": "autoScalingGroup", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.AutoScalingGroupAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 189 }, "name": "billing", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.BillingAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 190 }, "name": "cloudFront", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.CloudFrontAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 191 }, "name": "codeBuild", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.CodeBuildAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 192 }, "name": "documentDb", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.DocumentDbAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 193 }, "name": "dynamoDB", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.DynamoTableAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 194 }, "name": "ec2", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.EC2AspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 195 }, "name": "elasticCache", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.ElastiCacheAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 197 }, "name": "fargateLoadBalancedService", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.LoadBalancedFargateServiceAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 196 }, "name": "fargateService", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.FargateServiceAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 199 }, "name": "glue", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.GlueJobAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 200 }, "name": "kinesisDataAnalytics", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.KinesisDataAnalyticsAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 201 }, "name": "kinesisDataStream", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.KinesisDataStreamAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 202 }, "name": "kinesisDataStreamConsumer", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.KinesisDataStreamConsumerAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 203 }, "name": "kinesisFirehose", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.KinesisFirehoseAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 204 }, "name": "lambda", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.LambdaFunctionAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 205 }, "name": "openSearch", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.OpenSearchClusterAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 198 }, "name": "queueProcessingFargateService", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.QueueProcessingFargateServiceAspectType" } }, { "abstract": true, "docs": { "deprecated": "Use {@link rdsCluster } instead.", "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 209 }, "name": "rds", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RdsClusterAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 210 }, "name": "rdsCluster", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RdsClusterAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 211 }, "name": "rdsInstance", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RdsInstanceAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 212 }, "name": "redshift", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RedshiftClusterAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 213 }, "name": "s3", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.S3BucketAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 214 }, "name": "secretsManager", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.SecretsManagerSecretAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 215 }, "name": "sns", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.SnsTopicAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 216 }, "name": "sqs", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.SqsQueueAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 217 }, "name": "stepFunctions", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.StepFunctionAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 218 }, "name": "syntheticsCanaries", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.SyntheticsCanaryAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 219 }, "name": "webApplicationFirewallAclV2", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.WafV2AspectType" } } ], "symbolId": "lib/facade/IMonitoringAspect:MonitoringAspectProps" }, "cdk-monitoring-constructs.MonitoringDashboardsOverrideProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MonitoringDashboardsOverrideProps", "kind": "interface", "locationInModule": { "filename": "lib/dashboard/IDashboardFactory.ts", "line": 5 }, "name": "MonitoringDashboardsOverrideProps", "properties": [ { "abstract": true, "docs": { "default": "- true", "stability": "experimental", "summary": "Flag indicating if the widgets should be added to alarm dashboard." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/IDashboardFactory.ts", "line": 23 }, "name": "addToAlarmDashboard", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- true", "stability": "experimental", "summary": "Flag indicating if the widgets should be added to detailed dashboard." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/IDashboardFactory.ts", "line": 11 }, "name": "addToDetailDashboard", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- true", "stability": "experimental", "summary": "Flag indicating if the widgets should be added to summary dashboard." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/IDashboardFactory.ts", "line": 17 }, "name": "addToSummaryDashboard", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/dashboard/IDashboardFactory:MonitoringDashboardsOverrideProps" }, "cdk-monitoring-constructs.MonitoringDashboardsProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MonitoringDashboardsProps", "kind": "interface", "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 16 }, "name": "MonitoringDashboardsProps", "properties": [ { "abstract": true, "docs": { "remarks": "This allows to have all dashboards sorted close to each other and also separate multiple monitoring facades.", "stability": "experimental", "summary": "Prefix added to each dashboard name." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 21 }, "name": "dashboardNamePrefix", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- false", "remarks": "This is independent on other create dashboard flags.", "stability": "experimental", "summary": "Flag indicating whether the alarm dashboard should be created." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 63 }, "name": "createAlarmDashboard", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- true", "remarks": "This is independent on other create dashboard flags.", "stability": "experimental", "summary": "Flag indicating whether the default dashboard should be created." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 49 }, "name": "createDashboard", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- false", "remarks": "This is independent on other create dashboard flags.", "stability": "experimental", "summary": "Flag indicating whether the summary dashboard should be created." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 56 }, "name": "createSummaryDashboard", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- respect individual graphs (PeriodOverride.INHERIT)", "stability": "experimental", "summary": "Period override for the detail dashboard (and other auxiliary dashboards)." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 32 }, "name": "detailDashboardPeriodOverride", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.PeriodOverride" } }, { "abstract": true, "docs": { "default": "- 8 hours", "see": "DefaultDetailDashboardRange", "stability": "experimental", "summary": "Range of the detail dashboard (and other auxiliary dashboards)." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 27 }, "name": "detailDashboardRange", "optional": true, "type": { "fqn": "aws-cdk-lib.Duration" } }, { "abstract": true, "docs": { "default": "- DashboardRenderingPreference.INTERACTIVE_ONLY", "stability": "experimental", "summary": "Dashboard rendering preference." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 69 }, "name": "renderingPreference", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.DashboardRenderingPreference" } }, { "abstract": true, "docs": { "default": "- respect individual graphs (PeriodOverride.INHERIT)", "stability": "experimental", "summary": "Period override for the summary dashboard." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 42 }, "name": "summaryDashboardPeriodOverride", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.PeriodOverride" } }, { "abstract": true, "docs": { "default": "- 14 days", "stability": "experimental", "summary": "Range of the summary dashboard." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 37 }, "name": "summaryDashboardRange", "optional": true, "type": { "fqn": "aws-cdk-lib.Duration" } }, { "abstract": true, "docs": { "default": "- No variables", "stability": "experimental", "summary": "Dashboard variables to include in the dashboards." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 75 }, "name": "variables", "optional": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IVariable" }, "kind": "array" } } } ], "symbolId": "lib/dashboard/DefaultDashboardFactory:MonitoringDashboardsProps" }, "cdk-monitoring-constructs.MonitoringDynamicDashboardsProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MonitoringDynamicDashboardsProps", "kind": "interface", "locationInModule": { "filename": "lib/dashboard/DynamicDashboardFactory.ts", "line": 54 }, "name": "MonitoringDynamicDashboardsProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "List of dashboard types to generate." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DynamicDashboardFactory.ts", "line": 64 }, "name": "dashboardConfigs", "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DynamicDashboardConfiguration" }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "This allows to have all dashboards sorted close to each other and also separate multiple monitoring facades.", "stability": "experimental", "summary": "Prefix added to each dashboard's name." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DynamicDashboardFactory.ts", "line": 59 }, "name": "dashboardNamePrefix", "type": { "primitive": "string" } } ], "symbolId": "lib/dashboard/DynamicDashboardFactory:MonitoringDynamicDashboardsProps" }, "cdk-monitoring-constructs.MonitoringFacade": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.MonitoringScope", "docs": { "remarks": "This is a convenient main entrypoint to monitor resources.\n\nProvides methods for retrieving and creating alarms based on added segments that are subclasses of\n{@link Monitoring}.", "stability": "experimental", "summary": "An implementation of a {@link MonitoringScope}." }, "fqn": "cdk-monitoring-constructs.MonitoringFacade", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 194 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacadeProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 183 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Adds a dashboard segment which returns dynamic content depending on dashboard type." }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 249 }, "name": "addDynamicSegment", "parameters": [ { "docs": { "summary": "dynamic segment to add." }, "name": "segment", "type": { "fqn": "cdk-monitoring-constructs.IDynamicDashboardSegment" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 446 }, "name": "addLargeHeader", "parameters": [ { "name": "text", "type": { "primitive": "string" } }, { "name": "addToSummary", "optional": true, "type": { "primitive": "boolean" } }, { "name": "addToAlarm", "optional": true, "type": { "primitive": "boolean" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 459 }, "name": "addMediumHeader", "parameters": [ { "name": "text", "type": { "primitive": "string" } }, { "name": "addToSummary", "optional": true, "type": { "primitive": "boolean" } }, { "name": "addToAlarm", "optional": true, "type": { "primitive": "boolean" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental", "summary": "Adds a dashboard segment to go on one of the {@link DefaultDashboards}." }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 261 }, "name": "addSegment", "parameters": [ { "docs": { "summary": "segment to add." }, "name": "segment", "type": { "fqn": "cdk-monitoring-constructs.IDashboardSegment" } }, { "docs": { "summary": "props to specify which default dashboards this segment is added to." }, "name": "overrideProps", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringDashboardsOverrideProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 472 }, "name": "addSmallHeader", "parameters": [ { "name": "text", "type": { "primitive": "string" } }, { "name": "addToSummary", "optional": true, "type": { "primitive": "boolean" } }, { "name": "addToAlarm", "optional": true, "type": { "primitive": "boolean" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 485 }, "name": "addWidget", "parameters": [ { "name": "widget", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" } }, { "name": "addToSummary", "optional": true, "type": { "primitive": "boolean" } }, { "name": "addToAlarm", "optional": true, "type": { "primitive": "boolean" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "returns": "The list of clone alarms.", "stability": "experimental", "summary": "Applies a cloning function to each of the given alarms, creating a new collection of alarms that are adjusted by the function." }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 423 }, "name": "cloneAlarms", "parameters": [ { "docs": { "summary": "The alarms that should be used as sources for the clones." }, "name": "sourceAlarms", "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" }, "kind": "array" } } }, { "docs": { "summary": "A function that will accept a source alarm and determine whether and how a new alarm should be cloned from it." }, "name": "cloneFunction", "type": { "fqn": "cdk-monitoring-constructs.AlarmCloneFunction" } } ], "returns": { "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" }, "kind": "array" } } } }, { "docs": { "remarks": "Alarms created will be named with the given prefix, unless a local name override is present.", "stability": "experimental", "summary": "Creates a new alarm factory." }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 216 }, "name": "createAlarmFactory", "overrides": "cdk-monitoring-constructs.MonitoringScope", "parameters": [ { "name": "alarmNamePrefix", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } }, { "docs": { "stability": "experimental", "summary": "Creates a new factory that creates AWS Console URLs." }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 224 }, "name": "createAwsConsoleUrlFactory", "overrides": "cdk-monitoring-constructs.MonitoringScope", "returns": { "type": { "fqn": "cdk-monitoring-constructs.AwsConsoleUrlFactory" } } }, { "docs": { "remarks": "This composite alarm is created with an 'OR' condition, so it triggers with any child alarm.\nNOTE: This composite alarm is not added among other alarms, so it is not returned by createdAlarms() calls.", "stability": "experimental", "summary": "Finds a subset of created alarms that are marked by a specific disambiguator and creates a composite alarm." }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 394 }, "name": "createCompositeAlarmUsingDisambiguator", "parameters": [ { "docs": { "summary": "disambiguator to filter alarms by." }, "name": "alarmDisambiguator", "type": { "primitive": "string" } }, { "docs": { "summary": "customization options." }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.AddCompositeAlarmProps" } } ], "returns": { "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.CompositeAlarm" } } }, { "docs": { "remarks": "This composite alarm is created with an 'OR' condition, so it triggers with any child alarm.\nNOTE: This composite alarm is not added among other alarms, so it is not returned by createdAlarms() calls.", "stability": "experimental", "summary": "Finds a subset of created alarms that are marked by a specific custom tag and creates a composite alarm." }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 368 }, "name": "createCompositeAlarmUsingTag", "parameters": [ { "docs": { "summary": "tag to filter alarms by." }, "name": "customTag", "type": { "primitive": "string" } }, { "docs": { "summary": "customization options." }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.AddCompositeAlarmProps" } } ], "returns": { "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.CompositeAlarm" } } }, { "docs": { "deprecated": "- prefer calling dashboardFactory.getDashboard directly.", "returns": "default alarms dashboard", "stability": "deprecated" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 297 }, "name": "createdAlarmDashboard", "returns": { "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" } } }, { "docs": { "stability": "experimental", "summary": "Returns the created alarms across all added segments that subclass {@link Monitoring} added up until now." }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 305 }, "name": "createdAlarms", "returns": { "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns a subset of created alarms that are marked by a specific disambiguator." }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 328 }, "name": "createdAlarmsWithDisambiguator", "parameters": [ { "docs": { "summary": "disambiguator to filter alarms by." }, "name": "disambiguator", "type": { "primitive": "string" } } ], "returns": { "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns a subset of created alarms that are marked by a specific custom tag." }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 317 }, "name": "createdAlarmsWithTag", "parameters": [ { "docs": { "summary": "tag to filter alarms by." }, "name": "customTag", "type": { "primitive": "string" } } ], "returns": { "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns the added composite alarms." }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 337 }, "name": "createdCompositeAlarms", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.CompositeAlarm" }, "kind": "array" } } } }, { "docs": { "deprecated": "- prefer calling dashboardFactory.getDashboard directly.", "returns": "default detail dashboard", "stability": "deprecated" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 279 }, "name": "createdDashboard", "returns": { "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" } } }, { "docs": { "stability": "experimental", "summary": "Returns all the added segments." }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 353 }, "name": "createdDashboardSegments", "returns": { "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "cdk-monitoring-constructs.IDashboardSegment" }, { "fqn": "cdk-monitoring-constructs.IDynamicDashboardSegment" } ] } }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns the added segments that subclass {@link Monitoring}." }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 344 }, "name": "createdMonitorings", "returns": { "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.Monitoring" }, "kind": "array" } } } }, { "docs": { "deprecated": "- prefer calling dashboardFactory.getDashboard directly.", "returns": "default summary dashboard", "stability": "deprecated" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 288 }, "name": "createdSummaryDashboard", "returns": { "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" } } }, { "docs": { "stability": "experimental", "summary": "Creates a new metric factory." }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 231 }, "name": "createMetricFactory", "overrides": "cdk-monitoring-constructs.MonitoringScope", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } } }, { "docs": { "stability": "experimental", "summary": "Creates a new widget factory." }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 237 }, "name": "createWidgetFactory", "overrides": "cdk-monitoring-constructs.MonitoringScope", "returns": { "type": { "fqn": "cdk-monitoring-constructs.IWidgetFactory" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 515 }, "name": "monitorApiGateway", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.ApiGatewayMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 521 }, "name": "monitorApiGatewayV2HttpApi", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.ApiGatewayV2HttpApiMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 527 }, "name": "monitorAppSyncApi", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AppSyncMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 533 }, "name": "monitorAuroraCluster", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AuroraClusterMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 753 }, "name": "monitorAutoScalingGroup", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AutoScalingGroupMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 903 }, "name": "monitorBilling", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.BillingMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 539 }, "name": "monitorCertificate", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.CertificateManagerMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 545 }, "name": "monitorCloudFrontDistribution", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.CloudFrontDistributionMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 553 }, "name": "monitorCodeBuildProject", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.CodeBuildProjectMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 909 }, "name": "monitorCustom", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.CustomMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 559 }, "name": "monitorDocumentDbCluster", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.DocumentDbMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 565 }, "name": "monitorDynamoTable", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.DynamoTableMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 571 }, "name": "monitorDynamoTableGlobalSecondaryIndex", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.DynamoTableGlobalSecondaryIndexMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 722 }, "name": "monitorEc2ApplicationLoadBalancer", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.Ec2ApplicationLoadBalancerMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 579 }, "name": "monitorEC2Instances", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.EC2MonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 709 }, "name": "monitorEc2NetworkLoadBalancer", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.Ec2NetworkLoadBalancerMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 689 }, "name": "monitorEc2Service", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.Ec2ServiceMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 621 }, "name": "monitorElastiCacheCluster", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.ElastiCacheClusterMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 585 }, "name": "monitorElasticsearchCluster", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.OpenSearchClusterMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 676 }, "name": "monitorFargateApplicationLoadBalancer", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.FargateApplicationLoadBalancerMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 663 }, "name": "monitorFargateNetworkLoadBalancer", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.FargateNetworkLoadBalancerMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 641 }, "name": "monitorFargateService", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.FargateServiceMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 915 }, "name": "monitorFluentBit", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.FluentBitMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 635 }, "name": "monitorGlueJob", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.GlueJobMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 779 }, "name": "monitorKinesisDataAnalytics", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.KinesisDataAnalyticsMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 765 }, "name": "monitorKinesisDataStream", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.KinesisDataStreamMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 771 }, "name": "monitorKinesisDataStreamConsumer", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.KinesisDataStreamConsumerMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 759 }, "name": "monitorKinesisFirehose", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.KinesisFirehoseMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 787 }, "name": "monitorLambdaFunction", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.LambdaFunctionMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 885 }, "name": "monitorLog", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.LogMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 793 }, "name": "monitorNetworkLoadBalancer", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.NetworkLoadBalancerMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 591 }, "name": "monitorOpenSearchCluster", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.OpenSearchClusterMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 597 }, "name": "monitorOpenSearchIngestionPipeline", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.OpenSearchIngestionPipelineMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 605 }, "name": "monitorOpenSearchServerlessCollection", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.OpenSearchServerlessMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 613 }, "name": "monitorOpenSearchServerlessIndex", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.OpenSearchServerlessIndexMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 744 }, "name": "monitorQueueProcessingEc2Service", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.QueueProcessingEc2ServiceMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 735 }, "name": "monitorQueueProcessingFargateService", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.QueueProcessingFargateServiceMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 799 }, "name": "monitorRdsCluster", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.RdsClusterMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 805 }, "name": "monitorRdsInstance", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.RdsInstanceMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 811 }, "name": "monitorRedshiftCluster", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.RedshiftClusterMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 879 }, "name": "monitorS3Bucket", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.S3BucketMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental", "summary": "Uses an aspect to automatically monitor all resources in the given scope." }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 509 }, "name": "monitorScope", "parameters": [ { "docs": { "summary": "Scope with resources to monitor." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "Optional configuration." }, "name": "aspectProps", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 817 }, "name": "monitorSecretsManager", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.SecretsManagerMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 823 }, "name": "monitorSecretsManagerSecret", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.SecretsManagerSecretMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 627 }, "name": "monitorServerlessElastiCache", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.ElastiCacheServerlessMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 700 }, "name": "monitorSimpleEc2Service", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.SimpleEc2ServiceMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 652 }, "name": "monitorSimpleFargateService", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.SimpleFargateServiceMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 831 }, "name": "monitorSnsTopic", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.SnsTopicMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 837 }, "name": "monitorSqsQueue", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.SqsQueueMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 843 }, "name": "monitorSqsQueueWithDlq", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.SqsQueueMonitoringWithDlqProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 849 }, "name": "monitorStepFunction", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.StepFunctionMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 855 }, "name": "monitorStepFunctionActivity", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.StepFunctionActivityMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 863 }, "name": "monitorStepFunctionLambdaIntegration", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.StepFunctionLambdaIntegrationMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 871 }, "name": "monitorStepFunctionServiceIntegration", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.StepFunctionServiceIntegrationMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 891 }, "name": "monitorSyntheticsCanary", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.SyntheticsCanaryMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 897 }, "name": "monitorWebApplicationFirewallAclV2", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.WafV2MonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } } ], "name": "MonitoringFacade", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 185 }, "name": "alarmFactoryDefaults", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactoryDefaults" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 192 }, "name": "createdClones", "protected": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 191 }, "name": "createdComposites", "protected": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.CompositeAlarm" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 187 }, "name": "createdSegments", "protected": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "cdk-monitoring-constructs.IDashboardSegment" }, { "fqn": "cdk-monitoring-constructs.IDynamicDashboardSegment" } ] } }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 184 }, "name": "metricFactoryDefaults", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactoryDefaults" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 186 }, "name": "dashboardFactory", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.IDynamicDashboardFactory" } } ], "symbolId": "lib/facade/MonitoringFacade:MonitoringFacade" }, "cdk-monitoring-constructs.MonitoringFacadeProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MonitoringFacadeProps", "kind": "interface", "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 152 }, "name": "MonitoringFacadeProps", "properties": [ { "abstract": true, "docs": { "default": "- actions enabled, facade logical ID used as default alarm name prefix", "stability": "experimental", "summary": "Defaults for alarm factory." }, "immutable": true, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 165 }, "name": "alarmFactoryDefaults", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactoryDefaults" } }, { "abstract": true, "docs": { "default": "- An instance of {@link DynamicDashboardFactory }; facade logical ID used as default name", "stability": "experimental", "summary": "Defaults for dashboard factory." }, "immutable": true, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 172 }, "name": "dashboardFactory", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.IDynamicDashboardFactory" } }, { "abstract": true, "docs": { "default": "- empty (no preferences)", "stability": "experimental", "summary": "Defaults for metric factory." }, "immutable": true, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 158 }, "name": "metricFactoryDefaults", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactoryDefaults" } } ], "symbolId": "lib/facade/MonitoringFacade:MonitoringFacadeProps" }, "cdk-monitoring-constructs.MonitoringHeaderWidget": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.HeaderWidget", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/widget/MonitoringHeaderWidget.ts", "line": 12 }, "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidgetProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/dashboard/widget/MonitoringHeaderWidget.ts", "line": 11 }, "name": "MonitoringHeaderWidget", "symbolId": "lib/dashboard/widget/MonitoringHeaderWidget:MonitoringHeaderWidget" }, "cdk-monitoring-constructs.MonitoringHeaderWidgetProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidgetProps", "kind": "interface", "locationInModule": { "filename": "lib/dashboard/widget/MonitoringHeaderWidget.ts", "line": 3 }, "name": "MonitoringHeaderWidgetProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/MonitoringHeaderWidget.ts", "line": 4 }, "name": "title", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/MonitoringHeaderWidget.ts", "line": 7 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/MonitoringHeaderWidget.ts", "line": 8 }, "name": "descriptionHeight", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/MonitoringHeaderWidget.ts", "line": 5 }, "name": "family", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/MonitoringHeaderWidget.ts", "line": 6 }, "name": "goToLinkUrl", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/dashboard/widget/MonitoringHeaderWidget:MonitoringHeaderWidgetProps" }, "cdk-monitoring-constructs.MonitoringNamingStrategy": { "assembly": "cdk-monitoring-constructs", "docs": { "see": "https://docs.aws.amazon.com/cdk/latest/guide/tokens.html#tokens_lazy", "stability": "experimental", "summary": "Utility class to unify approach to naming monitoring sections." }, "fqn": "cdk-monitoring-constructs.MonitoringNamingStrategy", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/MonitoringNamingStrategy.ts", "line": 50 }, "parameters": [ { "name": "input", "type": { "fqn": "cdk-monitoring-constructs.NameResolutionInput" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/dashboard/MonitoringNamingStrategy.ts", "line": 47 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/MonitoringNamingStrategy.ts", "line": 62 }, "name": "isAlarmFriendly", "parameters": [ { "name": "str", "type": { "primitive": "string" } } ], "returns": { "type": { "union": { "types": [ { "primitive": "boolean" }, { "primitive": "string" } ] } } }, "static": true }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/MonitoringNamingStrategy.ts", "line": 54 }, "name": "resolveAlarmFriendlyName", "returns": { "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/MonitoringNamingStrategy.ts", "line": 58 }, "name": "resolveHumanReadableName", "returns": { "type": { "primitive": "string" } } } ], "name": "MonitoringNamingStrategy", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/MonitoringNamingStrategy.ts", "line": 48 }, "name": "input", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.NameResolutionInput" } } ], "symbolId": "lib/dashboard/MonitoringNamingStrategy:MonitoringNamingStrategy" }, "cdk-monitoring-constructs.MonitoringScope": { "abstract": true, "assembly": "cdk-monitoring-constructs", "base": "constructs.Construct", "docs": { "remarks": "Standard usages will use {@link MonitoringFacade }.", "stability": "experimental", "summary": "A scope where all monitored constructs are managed from (i.e., alarms, dashboards, etc.)." }, "fqn": "cdk-monitoring-constructs.MonitoringScope", "initializer": { "docs": { "stability": "stable", "summary": "Creates a new construct node." }, "locationInModule": { "filename": "src/construct.ts", "line": 448 }, "parameters": [ { "docs": { "summary": "The scope in which to define this construct." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "remarks": "Must be unique amongst siblings. If\nthe ID includes a path separator (`/`), then it will be replaced by double\ndash `--`.", "summary": "The scoped construct ID." }, "name": "id", "type": { "primitive": "string" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/MonitoringScope.ts", "line": 13 }, "methods": [ { "abstract": true, "docs": { "remarks": "Alarms created will be named with the given prefix, unless a local name override is present.", "stability": "experimental", "summary": "Creates a new alarm factory." }, "locationInModule": { "filename": "lib/common/monitoring/MonitoringScope.ts", "line": 30 }, "name": "createAlarmFactory", "parameters": [ { "docs": { "summary": "alarm name prefix." }, "name": "alarmNamePrefix", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Creates a new factory that creates AWS Console URLs." }, "locationInModule": { "filename": "lib/common/monitoring/MonitoringScope.ts", "line": 35 }, "name": "createAwsConsoleUrlFactory", "returns": { "type": { "fqn": "cdk-monitoring-constructs.AwsConsoleUrlFactory" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Creates a new metric factory." }, "locationInModule": { "filename": "lib/common/monitoring/MonitoringScope.ts", "line": 22 }, "name": "createMetricFactory", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Creates a new widget factory." }, "locationInModule": { "filename": "lib/common/monitoring/MonitoringScope.ts", "line": 17 }, "name": "createWidgetFactory", "returns": { "type": { "fqn": "cdk-monitoring-constructs.IWidgetFactory" } } } ], "name": "MonitoringScope", "symbolId": "lib/common/monitoring/MonitoringScope:MonitoringScope" }, "cdk-monitoring-constructs.MultipleAlarmActionStrategy": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental", "summary": "Alarm action strategy that combines multiple actions in the same order as they were given." }, "fqn": "cdk-monitoring-constructs.MultipleAlarmActionStrategy", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/action/MultipleAlarmActionStrategy.ts", "line": 22 }, "parameters": [ { "name": "actions", "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.IAlarmActionStrategy" }, "kind": "array" } } } ] }, "interfaces": [ "cdk-monitoring-constructs.IAlarmActionStrategy" ], "kind": "class", "locationInModule": { "filename": "lib/common/alarm/action/MultipleAlarmActionStrategy.ts", "line": 19 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/action/MultipleAlarmActionStrategy.ts", "line": 26 }, "name": "addAlarmActions", "overrides": "cdk-monitoring-constructs.IAlarmActionStrategy", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmActionStrategyProps" } } ] }, { "docs": { "returns": "flattened list of alarm actions.", "stability": "experimental", "summary": "Returns list of alarm actions where any nested instances of MultipleAlarmActionStrategy are flattened." }, "locationInModule": { "filename": "lib/common/alarm/action/MultipleAlarmActionStrategy.ts", "line": 36 }, "name": "flattenedAlarmActions", "returns": { "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.IAlarmActionStrategy" }, "kind": "array" } } } } ], "name": "MultipleAlarmActionStrategy", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/action/MultipleAlarmActionStrategy.ts", "line": 20 }, "name": "actions", "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.IAlarmActionStrategy" }, "kind": "array" } } } ], "symbolId": "lib/common/alarm/action/MultipleAlarmActionStrategy:MultipleAlarmActionStrategy" }, "cdk-monitoring-constructs.NameResolutionInput": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.NameResolutionInput", "interfaces": [ "cdk-monitoring-constructs.UserProvidedNames" ], "kind": "interface", "locationInModule": { "filename": "lib/dashboard/MonitoringNamingStrategy.ts", "line": 4 }, "name": "NameResolutionInput", "properties": [ { "abstract": true, "docs": { "default": "- use namedConstruct to extract the name", "remarks": "This might be some construct reference, such is cluster ID, stream name, and so on.", "stability": "experimental", "summary": "Fallback name before we fallback to extracting name from the construct itself." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/MonitoringNamingStrategy.ts", "line": 16 }, "name": "fallbackConstructName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "It is used as a last resort for naming.", "stability": "experimental", "summary": "Construct that this naming strategy is naming." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/MonitoringNamingStrategy.ts", "line": 9 }, "name": "namedConstruct", "optional": true, "type": { "fqn": "constructs.IConstruct" } } ], "symbolId": "lib/dashboard/MonitoringNamingStrategy:NameResolutionInput" }, "cdk-monitoring-constructs.NetworkInThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.NetworkInThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/EC2AlarmFactory.ts", "line": 12 }, "name": "NetworkInThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/EC2AlarmFactory.ts", "line": 13 }, "name": "maxNetworkInBytes", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/EC2AlarmFactory:NetworkInThreshold" }, "cdk-monitoring-constructs.NetworkLoadBalancerMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental", "summary": "Metric factory to create metrics for network load-balanced service." }, "fqn": "cdk-monitoring-constructs.NetworkLoadBalancerMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 48 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.NetworkLoadBalancerMetricFactoryProps" } } ] }, "interfaces": [ "cdk-monitoring-constructs.ILoadBalancerMetricFactory" ], "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 40 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 99 }, "name": "metricActiveConnectionCount", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 146 }, "name": "metricClientResetCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 168 }, "name": "metricElbResetCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 60 }, "name": "metricHealthyTaskCount", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 88 }, "name": "metricHealthyTaskInPercent", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 109 }, "name": "metricNewConnectionCount", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 119 }, "name": "metricProcessedBytesMin", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 157 }, "name": "metricTargetResetCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 130 }, "name": "metricUnhealthyRoutingCount", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 74 }, "name": "metricUnhealthyTaskCount", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "NetworkLoadBalancerMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 46 }, "name": "invertStatisticsOfTaskCountEnabled", "protected": true, "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 44 }, "name": "networkLoadBalancer", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.INetworkLoadBalancer" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 45 }, "name": "networkTargetGroup", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.INetworkTargetGroup" } } ], "symbolId": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory:NetworkLoadBalancerMetricFactory" }, "cdk-monitoring-constructs.NetworkLoadBalancerMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Props to create NetworkLoadBalancerMetricFactory." }, "fqn": "cdk-monitoring-constructs.NetworkLoadBalancerMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseLoadBalancerMetricFactoryProps", "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 23 }, "name": "NetworkLoadBalancerMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 26 }, "name": "networkLoadBalancer", "type": { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.INetworkLoadBalancer" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 27 }, "name": "networkTargetGroup", "type": { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.INetworkTargetGroup" } }, { "abstract": true, "docs": { "remarks": "Set explicitly to ensure that unnecessary widgets are not rendered.\nBy default, we will provide task health metrics, which are not\nrelevant to the {@link TargetType.ALB} targets.", "stability": "experimental", "summary": "Target type for the NetworkLoadBalancer." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 34 }, "name": "networkLoadBalancerTargetType", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.TargetType" } } ], "symbolId": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory:NetworkLoadBalancerMetricFactoryProps" }, "cdk-monitoring-constructs.NetworkLoadBalancerMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.NetworkLoadBalancerMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 74 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.NetworkLoadBalancerMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 53 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 204 }, "name": "createTaskHealthWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 215 }, "name": "createTcpFlowsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 231 }, "name": "createTcpResetCountsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 197 }, "name": "createTitleWidget", "protected": true, "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 161 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 179 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "NetworkLoadBalancerMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 66 }, "name": "activeTcpFlowCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 70 }, "name": "clientResetCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 72 }, "name": "elbResetCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 63 }, "name": "healthyTaskCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 65 }, "name": "healthyTaskPercentMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 54 }, "name": "humanReadableName", "protected": true, "type": { "primitive": "string" } }, { "docs": { "see": "https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-cloudwatch-metrics.html", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 248 }, "name": "isTaskHealthSupported", "protected": true, "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 55 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.NetworkLoadBalancerMetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 67 }, "name": "newTcpFlowCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 61 }, "name": "processedBytesAnnotations", "protected": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 69 }, "name": "processedBytesMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 71 }, "name": "targetResetCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 58 }, "name": "taskHealthAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.TaskHealthAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 60 }, "name": "taskHealthAnnotations", "protected": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 59 }, "name": "throughputAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.ThroughputAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 68 }, "name": "unhealthyRoutingFlowCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 64 }, "name": "unhealthyTaskCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 56 }, "name": "networkLoadBalancerTargetType", "optional": true, "protected": true, "type": { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.TargetType" } } ], "symbolId": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring:NetworkLoadBalancerMonitoring" }, "cdk-monitoring-constructs.NetworkLoadBalancerMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.NetworkLoadBalancerMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.NetworkLoadBalancerMetricFactoryProps", "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 35 }, "name": "NetworkLoadBalancerMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 38 }, "name": "addHealthyTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.HealthyTaskCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 43 }, "name": "addHealthyTaskPercentAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.HealthyTaskPercentThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 47 }, "name": "addMinProcessedBytesAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MinProcessedBytesThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 39 }, "name": "addUnhealthyTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UnhealthyTaskCountThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring:NetworkLoadBalancerMonitoringProps" }, "cdk-monitoring-constructs.NetworkOutThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.NetworkOutThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/EC2AlarmFactory.ts", "line": 8 }, "name": "NetworkOutThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/EC2AlarmFactory.ts", "line": 9 }, "name": "maxNetworkOutBytes", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/EC2AlarmFactory:NetworkOutThreshold" }, "cdk-monitoring-constructs.NoopAlarmActionStrategy": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental", "summary": "Alarm action strategy that does not add any actions." }, "fqn": "cdk-monitoring-constructs.NoopAlarmActionStrategy", "initializer": { "docs": { "stability": "experimental" } }, "interfaces": [ "cdk-monitoring-constructs.IAlarmActionStrategy" ], "kind": "class", "locationInModule": { "filename": "lib/common/alarm/action/NoopAlarmActionStrategy.ts", "line": 13 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/action/NoopAlarmActionStrategy.ts", "line": 14 }, "name": "addAlarmActions", "overrides": "cdk-monitoring-constructs.IAlarmActionStrategy", "parameters": [ { "name": "_props", "type": { "fqn": "cdk-monitoring-constructs.AlarmActionStrategyProps" } } ] } ], "name": "NoopAlarmActionStrategy", "symbolId": "lib/common/alarm/action/NoopAlarmActionStrategy:NoopAlarmActionStrategy" }, "cdk-monitoring-constructs.NotificationsFailedThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.NotificationsFailedThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/TopicAlarmFactory.ts", "line": 17 }, "name": "NotificationsFailedThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/TopicAlarmFactory.ts", "line": 18 }, "name": "maxNotificationsFailedCount", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/TopicAlarmFactory:NotificationsFailedThreshold" }, "cdk-monitoring-constructs.OpenSearchBackportedMetrics": { "assembly": "cdk-monitoring-constructs", "docs": { "custom": { "aws-cdk": "/aws-elasticsearch@1.65.0." }, "see": "https://github.com/aws/aws-cdk/releases/tag/v1.73.0", "stability": "experimental", "summary": "Backported set of metric functions added in." }, "fqn": "cdk-monitoring-constructs.OpenSearchBackportedMetrics", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchBackportedMetrics.ts", "line": 30 }, "parameters": [ { "name": "domain", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_opensearchservice.CfnDomain" }, { "fqn": "aws-cdk-lib.aws_opensearchservice.IDomain" }, { "fqn": "aws-cdk-lib.aws_elasticsearch.CfnDomain" }, { "fqn": "aws-cdk-lib.aws_elasticsearch.IDomain" } ] } } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchBackportedMetrics.ts", "line": 27 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Return the given named metric for this Domain." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchBackportedMetrics.ts", "line": 40 }, "name": "metric", "parameters": [ { "name": "metricName", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } } }, { "docs": { "default": "- maximum over 5 minutes", "stability": "experimental", "summary": "Metric for automated snapshot failures." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchBackportedMetrics.ts", "line": 127 }, "name": "metricAutomatedSnapshotFailure", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } } }, { "docs": { "default": "- maximum over 1 minute", "deprecated": "use metricClusterIndexWritesBlocked instead.", "stability": "deprecated", "summary": "Metric for the cluster blocking index writes." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchBackportedMetrics.ts", "line": 105 }, "name": "metricClusterIndexWriteBlocked", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } } }, { "docs": { "default": "- maximum over 1 minute", "stability": "experimental", "summary": "Metric for the cluster blocking index writes." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchBackportedMetrics.ts", "line": 90 }, "name": "metricClusterIndexWritesBlocked", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } } }, { "docs": { "default": "- maximum over 5 minutes", "stability": "experimental", "summary": "Metric for the time the cluster status is red." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchBackportedMetrics.ts", "line": 54 }, "name": "metricClusterStatusRed", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } } }, { "docs": { "default": "- maximum over 5 minutes", "stability": "experimental", "summary": "Metric for the time the cluster status is yellow." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchBackportedMetrics.ts", "line": 66 }, "name": "metricClusterStatusYellow", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } } }, { "docs": { "default": "- maximum over 5 minutes", "stability": "experimental", "summary": "Metric for CPU utilization." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchBackportedMetrics.ts", "line": 139 }, "name": "metricCPUUtilization", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } } }, { "docs": { "default": "- minimum over 5 minutes", "stability": "experimental", "summary": "Metric for the storage space of nodes in the cluster." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchBackportedMetrics.ts", "line": 78 }, "name": "metricFreeStorageSpace", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } } }, { "docs": { "default": "- p99 over 5 minutes", "stability": "experimental", "summary": "Metric for indexing latency." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchBackportedMetrics.ts", "line": 232 }, "name": "metricIndexingLatency", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } } }, { "docs": { "default": "- maximum over 5 minutes", "stability": "experimental", "summary": "Metric for JVM memory pressure." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchBackportedMetrics.ts", "line": 151 }, "name": "metricJVMMemoryPressure", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } } }, { "docs": { "default": "- maximum over 5 minutes", "stability": "experimental", "summary": "Metric for KMS key errors." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchBackportedMetrics.ts", "line": 187 }, "name": "metricKMSKeyError", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } } }, { "docs": { "default": "- maximum over 5 minutes", "stability": "experimental", "summary": "Metric for KMS key being inaccessible." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchBackportedMetrics.ts", "line": 199 }, "name": "metricKMSKeyInaccessible", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } } }, { "docs": { "default": "- maximum over 5 minutes", "stability": "experimental", "summary": "Metric for master CPU utilization." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchBackportedMetrics.ts", "line": 163 }, "name": "metricMasterCPUUtilization", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } } }, { "docs": { "default": "- maximum over 5 minutes", "stability": "experimental", "summary": "Metric for master JVM memory pressure." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchBackportedMetrics.ts", "line": 175 }, "name": "metricMasterJVMMemoryPressure", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } } }, { "docs": { "default": "- minimum over 1 hour", "stability": "experimental", "summary": "Metric for the number of nodes." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchBackportedMetrics.ts", "line": 114 }, "name": "metricNodes", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } } }, { "docs": { "default": "- maximum over 5 minutes", "stability": "experimental", "summary": "Metric for number of searchable documents." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchBackportedMetrics.ts", "line": 211 }, "name": "metricSearchableDocuments", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } } }, { "docs": { "default": "- p99 over 5 minutes", "stability": "experimental", "summary": "Metric for search latency." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchBackportedMetrics.ts", "line": 223 }, "name": "metricSearchLatency", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } } } ], "name": "OpenSearchBackportedMetrics", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchBackportedMetrics.ts", "line": 28 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-opensearch/OpenSearchBackportedMetrics:OpenSearchBackportedMetrics" }, "cdk-monitoring-constructs.OpenSearchClusterAlarmFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchClusterAlarmFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory.ts", "line": 50 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory.ts", "line": 47 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory.ts", "line": 117 }, "name": "addAutomatedSnapshotFailureAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.OpenSearchClusterAutomatedSnapshotFailureThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory.ts", "line": 75 }, "name": "addClusterIndexWritesBlockedAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.OpenSearchClusterIndexWritesBlockedThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory.ts", "line": 96 }, "name": "addClusterNodeCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.OpenSearchClusterNodesThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory.ts", "line": 54 }, "name": "addClusterStatusAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.OpenSearchClusterStatusCustomization" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory.ts", "line": 138 }, "name": "addKmsKeyErrorAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.OpenSearchKmsKeyErrorThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory.ts", "line": 159 }, "name": "addKmsKeyInaccessibleAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.OpenSearchKmsKeyInaccessibleThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } } ], "name": "OpenSearchClusterAlarmFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory.ts", "line": 48 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ], "symbolId": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory:OpenSearchClusterAlarmFactory" }, "cdk-monitoring-constructs.OpenSearchClusterAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchClusterAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 137 }, "name": "OpenSearchClusterAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 138 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.OpenSearchClusterMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:OpenSearchClusterAspectType" }, "cdk-monitoring-constructs.OpenSearchClusterAutomatedSnapshotFailureThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchClusterAutomatedSnapshotFailureThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory.ts", "line": 33 }, "name": "OpenSearchClusterAutomatedSnapshotFailureThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory.ts", "line": 35 }, "name": "maxFailures", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory:OpenSearchClusterAutomatedSnapshotFailureThreshold" }, "cdk-monitoring-constructs.OpenSearchClusterIndexWritesBlockedThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchClusterIndexWritesBlockedThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory.ts", "line": 24 }, "name": "OpenSearchClusterIndexWritesBlockedThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory.ts", "line": 26 }, "name": "maxBlockedWrites", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory:OpenSearchClusterIndexWritesBlockedThreshold" }, "cdk-monitoring-constructs.OpenSearchClusterMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchClusterMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 33 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.OpenSearchClusterMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 28 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 241 }, "name": "metricAutomatedSnapshotFailure", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "deprecated": "use metricClusterIndexWritesBlocked instead", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 227 }, "name": "metricClusterIndexWriteBlocked", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 214 }, "name": "metricClusterIndexWritesBlocked", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 136 }, "name": "metricClusterStatusRed", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 146 }, "name": "metricClusterStatusYellow", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 174 }, "name": "metricCpuUsage", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 156 }, "name": "metricDiskSpaceUsageInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 70 }, "name": "metricIndexingLatencyP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 81 }, "name": "metricIndexingLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 92 }, "name": "metricIndexingLatencyP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 194 }, "name": "metricJvmMemoryPressure", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 251 }, "name": "metricKmsKeyError", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 261 }, "name": "metricKmsKeyInaccessible", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 184 }, "name": "metricMasterCpuUsage", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 204 }, "name": "metricMasterJvmMemoryPressure", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 231 }, "name": "metricNodes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 45 }, "name": "metricSearchCount", "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 103 }, "name": "metricSearchLatencyP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 114 }, "name": "metricSearchLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 125 }, "name": "metricSearchLatencyP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 53 }, "name": "metricSearchRate", "parameters": [ { "name": "rateComputationMethod", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "deprecated": "use metricSearchRate", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 66 }, "name": "metricTps", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "OpenSearchClusterMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 29 }, "name": "domainMetrics", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.OpenSearchBackportedMetrics" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 30 }, "name": "fillTpsWithZeroes", "protected": true, "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 31 }, "name": "rateComputationMethod", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory:OpenSearchClusterMetricFactory" }, "cdk-monitoring-constructs.OpenSearchClusterMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchClusterMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 15 }, "name": "OpenSearchClusterMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 17 }, "name": "domain", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_opensearchservice.CfnDomain" }, { "fqn": "aws-cdk-lib.aws_opensearchservice.IDomain" }, { "fqn": "aws-cdk-lib.aws_elasticsearch.CfnDomain" }, { "fqn": "aws-cdk-lib.aws_elasticsearch.IDomain" } ] } } }, { "abstract": true, "docs": { "default": "- true", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 21 }, "name": "fillTpsWithZeroes", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- average", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 25 }, "name": "rateComputationMethod", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory:OpenSearchClusterMetricFactoryProps" }, "cdk-monitoring-constructs.OpenSearchClusterMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchClusterMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 126 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.OpenSearchClusterMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 88 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 397 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 461 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "OpenSearchClusterMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 122 }, "name": "automatedSnapshotFailureMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 96 }, "name": "clusterAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.OpenSearchClusterAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 97 }, "name": "clusterAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 111 }, "name": "clusterStatusRedMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 112 }, "name": "clusterStatusYellowMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 115 }, "name": "cpuUsageMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 114 }, "name": "diskSpaceUsageMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 92 }, "name": "indexingLatencyAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 93 }, "name": "indexingLatencyAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 120 }, "name": "indexWriteBlockedMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 117 }, "name": "jvmMemoryPressureMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 123 }, "name": "kmsKeyErrorMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 124 }, "name": "kmsKeyInaccessibleMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 116 }, "name": "masterCpuUsageMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 118 }, "name": "masterJvmMemoryPressureMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 101 }, "name": "masterUsageAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 98 }, "name": "nodeAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 121 }, "name": "nodesMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 104 }, "name": "p50IndexingLatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 107 }, "name": "p50SearchLatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 105 }, "name": "p90IndexingLatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 108 }, "name": "p90SearchLatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 106 }, "name": "p99IndexingLatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 109 }, "name": "p99SearchLatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 94 }, "name": "searchLatencyAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 95 }, "name": "searchLatencyAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 89 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 103 }, "name": "tpsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 99 }, "name": "usageAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.UsageAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 100 }, "name": "usageAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 90 }, "name": "url", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring:OpenSearchClusterMonitoring" }, "cdk-monitoring-constructs.OpenSearchClusterMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchClusterMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 45 }, "name": "OpenSearchClusterMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 72 }, "name": "addClusterAutomatedSnapshotFailureAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.OpenSearchClusterAutomatedSnapshotFailureThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 64 }, "name": "addClusterIndexWritesBlockedAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.OpenSearchClusterIndexWritesBlockedThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 68 }, "name": "addClusterNodeCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.OpenSearchClusterNodesThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 54 }, "name": "addClusterStatusAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.OpenSearchClusterStatusCustomization" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 59 }, "name": "addCpuSpaceUsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 58 }, "name": "addDiskSpaceUsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 47 }, "name": "addIndexingLatencyP50Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 48 }, "name": "addIndexingLatencyP90Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 49 }, "name": "addIndexingLatencyP99Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 61 }, "name": "addJvmMemoryPressureAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 77 }, "name": "addKmsKeyErrorAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.OpenSearchKmsKeyErrorThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 78 }, "name": "addKmsKeyInaccessibleAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.OpenSearchKmsKeyInaccessibleThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 60 }, "name": "addMasterCpuSpaceUsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 62 }, "name": "addMasterJvmMemoryPressureAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 50 }, "name": "addSearchLatencyP50Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 51 }, "name": "addSearchLatencyP90Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 52 }, "name": "addSearchLatencyP99Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring:OpenSearchClusterMonitoringOptions" }, "cdk-monitoring-constructs.OpenSearchClusterMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchClusterMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.OpenSearchClusterMetricFactoryProps", "cdk-monitoring-constructs.OpenSearchClusterMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 84 }, "name": "OpenSearchClusterMonitoringProps", "symbolId": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring:OpenSearchClusterMonitoringProps" }, "cdk-monitoring-constructs.OpenSearchClusterNodesThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchClusterNodesThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory.ts", "line": 29 }, "name": "OpenSearchClusterNodesThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory.ts", "line": 30 }, "name": "minNodes", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory:OpenSearchClusterNodesThreshold" }, "cdk-monitoring-constructs.OpenSearchClusterStatus": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchClusterStatus", "kind": "enum", "locationInModule": { "filename": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory.ts", "line": 9 }, "members": [ { "docs": { "stability": "experimental" }, "name": "RED" }, { "docs": { "stability": "experimental" }, "name": "YELLOW" } ], "name": "OpenSearchClusterStatus", "symbolId": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory:OpenSearchClusterStatus" }, "cdk-monitoring-constructs.OpenSearchClusterStatusCustomization": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchClusterStatusCustomization", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory.ts", "line": 19 }, "name": "OpenSearchClusterStatusCustomization", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory.ts", "line": 21 }, "name": "status", "type": { "union": { "types": [ { "fqn": "cdk-monitoring-constructs.OpenSearchClusterStatus" }, { "fqn": "cdk-monitoring-constructs.ElasticsearchClusterStatus" } ] } } } ], "symbolId": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory:OpenSearchClusterStatusCustomization" }, "cdk-monitoring-constructs.OpenSearchIngestionPipelineMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "see": "https://docs.aws.amazon.com/opensearch-service/latest/developerguide/monitoring-pipeline-metrics.html", "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchIngestionPipelineMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMetricFactory.ts", "line": 32 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.OpenSearchIngestionPipelineMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMetricFactory.ts", "line": 25 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMetricFactory.ts", "line": 117 }, "name": "metricDlqS3RecordsCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMetricFactory.ts", "line": 142 }, "name": "metricDlqS3RecordsFailedCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMetricFactory.ts", "line": 128 }, "name": "metricDlqS3RecordsSuccessCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMetricFactory.ts", "line": 89 }, "name": "metricRecordsProcessedCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMetricFactory.ts", "line": 75 }, "name": "metricSinkBulkPipelineLatencyMax", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMetricFactory.ts", "line": 61 }, "name": "metricSinkBulkRequestLatencyMax", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMetricFactory.ts", "line": 103 }, "name": "metricSinkRecordsInCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMetricFactory.ts", "line": 47 }, "name": "metricSourceBytesReceivedSum", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "OpenSearchIngestionPipelineMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMetricFactory.ts", "line": 30 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMetricFactory.ts", "line": 28 }, "name": "sink", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMetricFactory.ts", "line": 27 }, "name": "source", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMetricFactory.ts", "line": 26 }, "name": "subPipelineName", "protected": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMetricFactory:OpenSearchIngestionPipelineMetricFactory" }, "cdk-monitoring-constructs.OpenSearchIngestionPipelineMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchIngestionPipelineMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMetricFactory.ts", "line": 12 }, "name": "OpenSearchIngestionPipelineMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMetricFactory.ts", "line": 17 }, "name": "pipelineName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMetricFactory.ts", "line": 16 }, "name": "sink", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMetricFactory.ts", "line": 15 }, "name": "source", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMetricFactory.ts", "line": 14 }, "name": "subPipelineName", "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMetricFactory:OpenSearchIngestionPipelineMetricFactoryProps" }, "cdk-monitoring-constructs.OpenSearchIngestionPipelineMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchIngestionPipelineMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring.ts", "line": 51 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.OpenSearchIngestionPipelineMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring.ts", "line": 36 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring.ts", "line": 149 }, "name": "createDlqS3Widget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring.ts", "line": 137 }, "name": "createIncomingDataWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring.ts", "line": 124 }, "name": "createLatencyWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring.ts", "line": 116 }, "name": "createTitleWidget", "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring.ts", "line": 101 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring.ts", "line": 105 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "OpenSearchIngestionPipelineMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring.ts", "line": 46 }, "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring.ts", "line": 44 }, "name": "metricDlqS3RecordsCount", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring.ts", "line": 43 }, "name": "metricSinkBulkPipelineLatencyMax", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring.ts", "line": 42 }, "name": "metricSinkBulkRequestLatencyMax", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring.ts", "line": 40 }, "name": "metricSinkRecordsInCount", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring.ts", "line": 41 }, "name": "metricSourceBytesReceivedSum", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring.ts", "line": 37 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring.ts", "line": 47 }, "name": "usageAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.UsageAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring.ts", "line": 49 }, "name": "usageAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring.ts", "line": 38 }, "name": "pipelineUrl", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring:OpenSearchIngestionPipelineMonitoring" }, "cdk-monitoring-constructs.OpenSearchIngestionPipelineMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchIngestionPipelineMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring.ts", "line": 24 }, "name": "OpenSearchIngestionPipelineMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring.ts", "line": 26 }, "name": "addMaxDlqS3CountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MaxUsageCountThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring:OpenSearchIngestionPipelineMonitoringOptions" }, "cdk-monitoring-constructs.OpenSearchIngestionPipelineMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchIngestionPipelineMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.OpenSearchIngestionPipelineMetricFactoryProps", "cdk-monitoring-constructs.OpenSearchIngestionPipelineMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring.ts", "line": 29 }, "name": "OpenSearchIngestionPipelineMonitoringProps", "symbolId": "lib/monitoring/aws-osis/OpenSearchIngestionPipelineMonitoring:OpenSearchIngestionPipelineMonitoringProps" }, "cdk-monitoring-constructs.OpenSearchKmsKeyErrorThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchKmsKeyErrorThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory.ts", "line": 38 }, "name": "OpenSearchKmsKeyErrorThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory.ts", "line": 39 }, "name": "maxErrors", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory:OpenSearchKmsKeyErrorThreshold" }, "cdk-monitoring-constructs.OpenSearchKmsKeyInaccessibleThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchKmsKeyInaccessibleThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory.ts", "line": 42 }, "name": "OpenSearchKmsKeyInaccessibleThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory.ts", "line": 44 }, "name": "maxAccessAttempts", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/OpenSearchClusterAlarmFactory:OpenSearchKmsKeyInaccessibleThreshold" }, "cdk-monitoring-constructs.OpenSearchServerlessIndexMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "see": "https://docs.aws.amazon.com/opensearch-service/latest/developerguide/monitoring-cloudwatch.html", "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchServerlessIndexMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessIndexMetricFactory.ts", "line": 29 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.OpenSearchServerlessIndexMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessIndexMetricFactory.ts", "line": 26 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessIndexMetricFactory.ts", "line": 44 }, "name": "metricIndexSearchableDocuments", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "OpenSearchServerlessIndexMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessIndexMetricFactory.ts", "line": 27 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessIndexMetricFactory:OpenSearchServerlessIndexMetricFactory" }, "cdk-monitoring-constructs.OpenSearchServerlessIndexMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchServerlessIndexMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessIndexMetricFactory.ts", "line": 14 }, "name": "OpenSearchServerlessIndexMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessIndexMetricFactory.ts", "line": 16 }, "name": "collection", "type": { "fqn": "aws-cdk-lib.aws_opensearchserverless.CfnCollection" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessIndexMetricFactory.ts", "line": 17 }, "name": "indexId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessIndexMetricFactory.ts", "line": 18 }, "name": "indexName", "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessIndexMetricFactory:OpenSearchServerlessIndexMetricFactoryProps" }, "cdk-monitoring-constructs.OpenSearchServerlessIndexMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchServerlessIndexMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessIndexMonitoring.ts", "line": 34 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.OpenSearchServerlessIndexMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessIndexMonitoring.ts", "line": 29 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessIndexMonitoring.ts", "line": 76 }, "name": "createDocumentsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessIndexMonitoring.ts", "line": 68 }, "name": "createTitleWidget", "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessIndexMonitoring.ts", "line": 57 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessIndexMonitoring.ts", "line": 61 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "OpenSearchServerlessIndexMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessIndexMonitoring.ts", "line": 32 }, "name": "metricIndexSearchableDocuments", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessIndexMonitoring.ts", "line": 30 }, "name": "title", "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessIndexMonitoring:OpenSearchServerlessIndexMonitoring" }, "cdk-monitoring-constructs.OpenSearchServerlessIndexMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchServerlessIndexMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.OpenSearchServerlessIndexMetricFactoryProps", "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessIndexMonitoring.ts", "line": 22 }, "name": "OpenSearchServerlessIndexMonitoringProps", "symbolId": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessIndexMonitoring:OpenSearchServerlessIndexMonitoringProps" }, "cdk-monitoring-constructs.OpenSearchServerlessMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "see": "https://docs.aws.amazon.com/opensearch-service/latest/developerguide/monitoring-cloudwatch.html", "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchServerlessMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMetricFactory.ts", "line": 38 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.OpenSearchServerlessMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMetricFactory.ts", "line": 34 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMetricFactory.ts", "line": 125 }, "name": "metric4xxCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMetricFactory.ts", "line": 139 }, "name": "metric4xxRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMetricFactory.ts", "line": 148 }, "name": "metric5xxCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMetricFactory.ts", "line": 162 }, "name": "metric5xxRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMetricFactory.ts", "line": 95 }, "name": "metricIngestionRequestErrors", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMetricFactory.ts", "line": 109 }, "name": "metricIngestionRequestLatency", "parameters": [ { "name": "statistic", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMetricFactory.ts", "line": 81 }, "name": "metricIngestionRequestSuccess", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMetricFactory.ts", "line": 53 }, "name": "metricSearchRequestErrors", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMetricFactory.ts", "line": 67 }, "name": "metricSearchRequestLatency", "parameters": [ { "name": "statistic", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "OpenSearchServerlessMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMetricFactory.ts", "line": 36 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMetricFactory.ts", "line": 35 }, "name": "rateComputationMethod", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMetricFactory:OpenSearchServerlessMetricFactory" }, "cdk-monitoring-constructs.OpenSearchServerlessMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchServerlessMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMetricFactory.ts", "line": 19 }, "name": "OpenSearchServerlessMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMetricFactory.ts", "line": 21 }, "name": "collection", "type": { "fqn": "aws-cdk-lib.aws_opensearchserverless.CfnCollection" } }, { "abstract": true, "docs": { "default": "- {@link RateComputationMethod.AVERAGE }", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMetricFactory.ts", "line": 26 }, "name": "rateComputationMethod", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMetricFactory:OpenSearchServerlessMetricFactoryProps" }, "cdk-monitoring-constructs.OpenSearchServerlessMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchServerlessMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 76 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.OpenSearchServerlessMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 49 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 251 }, "name": "createErrorCountWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 266 }, "name": "createErrorRateWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 293 }, "name": "createIngestionLatencyWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 277 }, "name": "createIngestionRequestsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 234 }, "name": "createSearchRequestLatencyWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 226 }, "name": "createTitleWidget", "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 204 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 208 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "OpenSearchServerlessMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 53 }, "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 55 }, "name": "errorAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 58 }, "name": "errorCountAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 59 }, "name": "errorRateAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 54 }, "name": "latencyAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 70 }, "name": "metric4xxErrorCount", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 71 }, "name": "metric4xxErrorRate", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 73 }, "name": "metric5xxErrorCount", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 74 }, "name": "metric5xxErrorRate", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 66 }, "name": "metricIngestionRequestErrorsCount", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 67 }, "name": "metricIngestionRequestLatencyAvg", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 68 }, "name": "metricIngestionRequestLatencyMax", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 65 }, "name": "metricIngestionRequestSuccessCount", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 61 }, "name": "metricSearchRequestErrorsCount", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 62 }, "name": "metricSearchRequestLatencyAvg", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 63 }, "name": "metricSearchRequestLatencyMax", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 57 }, "name": "searchLatencyAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 50 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 51 }, "name": "collectionUrl", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring:OpenSearchServerlessMonitoring" }, "cdk-monitoring-constructs.OpenSearchServerlessMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchServerlessMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 31 }, "name": "OpenSearchServerlessMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 36 }, "name": "add4xxCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 37 }, "name": "add4xxRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 38 }, "name": "add5xxCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 39 }, "name": "add5xxRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 34 }, "name": "addSearchErrorCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 33 }, "name": "addSearchLatencyP100Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring:OpenSearchServerlessMonitoringOptions" }, "cdk-monitoring-constructs.OpenSearchServerlessMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchServerlessMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.OpenSearchServerlessMetricFactoryProps", "cdk-monitoring-constructs.OpenSearchServerlessMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring.ts", "line": 42 }, "name": "OpenSearchServerlessMonitoringProps", "symbolId": "lib/monitoring/aws-opensearchserverless/OpenSearchServerlessMonitoring:OpenSearchServerlessMonitoringProps" }, "cdk-monitoring-constructs.OpsItemAlarmActionStrategy": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental", "summary": "Alarm action strategy that creates an AWS OpsCenter OpsItem." }, "fqn": "cdk-monitoring-constructs.OpsItemAlarmActionStrategy", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/action/OpsItemAlarmActionStrategy.ts", "line": 74 }, "parameters": [ { "name": "severity", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch_actions.OpsItemSeverity" } }, { "name": "category", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch_actions.OpsItemCategory" } } ] }, "interfaces": [ "cdk-monitoring-constructs.IAlarmActionStrategy" ], "kind": "class", "locationInModule": { "filename": "lib/common/alarm/action/OpsItemAlarmActionStrategy.ts", "line": 63 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/action/OpsItemAlarmActionStrategy.ts", "line": 79 }, "name": "addAlarmActions", "overrides": "cdk-monitoring-constructs.IAlarmActionStrategy", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmActionStrategyProps" } } ] } ], "name": "OpsItemAlarmActionStrategy", "properties": [ { "docs": { "stability": "experimental", "summary": "OPS Item Severity." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/action/OpsItemAlarmActionStrategy.ts", "line": 67 }, "name": "severity", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch_actions.OpsItemSeverity" } }, { "docs": { "stability": "experimental", "summary": "OPS Item Category." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/action/OpsItemAlarmActionStrategy.ts", "line": 72 }, "name": "category", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch_actions.OpsItemCategory" } } ], "symbolId": "lib/common/alarm/action/OpsItemAlarmActionStrategy:OpsItemAlarmActionStrategy" }, "cdk-monitoring-constructs.QueueAlarmFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.QueueAlarmFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/QueueAlarmFactory.ts", "line": 39 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/QueueAlarmFactory.ts", "line": 36 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/QueueAlarmFactory.ts", "line": 146 }, "name": "addMaxQueueIncomingMessagesCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MaxIncomingMessagesCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/QueueAlarmFactory.ts", "line": 85 }, "name": "addMaxQueueMessageAgeAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MaxMessageAgeThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/QueueAlarmFactory.ts", "line": 64 }, "name": "addMaxQueueMessageCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MaxMessageCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/QueueAlarmFactory.ts", "line": 106 }, "name": "addMaxQueueTimeToDrainMessagesAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MaxTimeToDrainThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/QueueAlarmFactory.ts", "line": 125 }, "name": "addMinQueueIncomingMessagesCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MinIncomingMessagesCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/QueueAlarmFactory.ts", "line": 43 }, "name": "addMinQueueMessageCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MinMessageCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } } ], "name": "QueueAlarmFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/QueueAlarmFactory.ts", "line": 37 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ], "symbolId": "lib/common/monitoring/alarms/QueueAlarmFactory:QueueAlarmFactory" }, "cdk-monitoring-constructs.QueueProcessingEc2ServiceMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.QueueProcessingEc2ServiceMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/misc.ts", "line": 35 }, "name": "QueueProcessingEc2ServiceMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/misc.ts", "line": 37 }, "name": "ec2Service", "type": { "fqn": "aws-cdk-lib.aws_ecs_patterns.QueueProcessingEc2Service" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/misc.ts", "line": 24 }, "name": "addDeadLetterQueueAlarms", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.BaseDlqAlarms" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/misc.ts", "line": 23 }, "name": "addQueueAlarms", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.BaseSqsQueueAlarms" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/misc.ts", "line": 22 }, "name": "addServiceAlarms", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.BaseFargateServiceAlarms" } } ], "symbolId": "lib/monitoring/aws-ecs-patterns/misc:QueueProcessingEc2ServiceMonitoringProps" }, "cdk-monitoring-constructs.QueueProcessingFargateServiceAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.QueueProcessingFargateServiceAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 106 }, "name": "QueueProcessingFargateServiceAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 108 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.BaseQueueProcessingFargateServiceMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:QueueProcessingFargateServiceAspectType" }, "cdk-monitoring-constructs.QueueProcessingFargateServiceMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.QueueProcessingFargateServiceMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/misc.ts", "line": 30 }, "name": "QueueProcessingFargateServiceMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/misc.ts", "line": 32 }, "name": "fargateService", "type": { "fqn": "aws-cdk-lib.aws_ecs_patterns.QueueProcessingFargateService" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/misc.ts", "line": 24 }, "name": "addDeadLetterQueueAlarms", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.BaseDlqAlarms" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/misc.ts", "line": 23 }, "name": "addQueueAlarms", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.BaseSqsQueueAlarms" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/misc.ts", "line": 22 }, "name": "addServiceAlarms", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.BaseFargateServiceAlarms" } } ], "symbolId": "lib/monitoring/aws-ecs-patterns/misc:QueueProcessingFargateServiceMonitoringProps" }, "cdk-monitoring-constructs.RateComputationMethod": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental", "summary": "Enumeration of different rate computation methods." }, "fqn": "cdk-monitoring-constructs.RateComputationMethod", "kind": "enum", "locationInModule": { "filename": "lib/common/metric/RateComputationMethod.ts", "line": 4 }, "members": [ { "docs": { "remarks": "Less sensitive than per-second when TPS > 1.", "stability": "experimental", "summary": "Number of occurrences relative to requests." }, "name": "AVERAGE" }, { "docs": { "remarks": "More sensitive than average when TPS > 1.", "stability": "experimental", "summary": "Number of occurrences per second." }, "name": "PER_SECOND" }, { "docs": { "stability": "experimental", "summary": "Number of occurrences per minute." }, "name": "PER_MINUTE" }, { "docs": { "stability": "experimental", "summary": "Number of occurrences per hour." }, "name": "PER_HOUR" }, { "docs": { "stability": "experimental", "summary": "Number of occurrences per day." }, "name": "PER_DAY" } ], "name": "RateComputationMethod", "symbolId": "lib/common/metric/RateComputationMethod:RateComputationMethod" }, "cdk-monitoring-constructs.RdsClusterAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RdsClusterAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 141 }, "name": "RdsClusterAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 142 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RdsClusterMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:RdsClusterAspectType" }, "cdk-monitoring-constructs.RdsClusterMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RdsClusterMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 33 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.RdsClusterMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 28 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 95 }, "name": "metricAverageCpuUsageInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 135 }, "name": "metricCommitLatencyInMillis", "parameters": [ { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 161 }, "name": "metricCommitLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 126 }, "name": "metricDeleteLatencyInMillis", "parameters": [ { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 157 }, "name": "metricDeleteLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 84 }, "name": "metricDiskSpaceUsageInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 76 }, "name": "metricFreeStorageInBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 108 }, "name": "metricInsertLatencyInMillis", "parameters": [ { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 149 }, "name": "metricInsertLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 165 }, "name": "metricReadIOPS", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 99 }, "name": "metricSelectLatencyInMillis", "parameters": [ { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 145 }, "name": "metricSelectLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 172 }, "name": "metricServerlessDatabaseCapacity", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 68 }, "name": "metricTotalConnectionCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 117 }, "name": "metricUpdateLatencyInMillis", "parameters": [ { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 153 }, "name": "metricUpdateLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 80 }, "name": "metricUsedStorageInBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 169 }, "name": "metricWriteIOPS", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "RdsClusterMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 29 }, "name": "clusterIdentifier", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 31 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 30 }, "name": "cluster", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_rds.IDatabaseCluster" }, { "fqn": "aws-cdk-lib.aws_rds.ServerlessCluster" } ] } } } ], "symbolId": "lib/monitoring/aws-rds/RdsClusterMetricFactory:RdsClusterMetricFactory" }, "cdk-monitoring-constructs.RdsClusterMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RdsClusterMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 16 }, "name": "RdsClusterMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "database cluster (either this or `clusterIdentifier` need to be specified)." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 25 }, "name": "cluster", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_rds.IDatabaseCluster" }, { "fqn": "aws-cdk-lib.aws_rds.ServerlessCluster" } ] } } }, { "abstract": true, "docs": { "deprecated": "please use `cluster` instead", "stability": "deprecated", "summary": "database cluster identifier (either this or `cluster` need to be specified)." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 21 }, "name": "clusterIdentifier", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-rds/RdsClusterMetricFactory:RdsClusterMetricFactoryProps" }, "cdk-monitoring-constructs.RdsClusterMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RdsClusterMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 148 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.RdsClusterMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 121 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 478 }, "name": "createConnectionsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 467 }, "name": "createCpuAndDiskUsageWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 516 }, "name": "createIOPSWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 489 }, "name": "createLatencyWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 459 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 436 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 449 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "RdsClusterMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 145 }, "name": "commitLatencyMetrics", "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 126 }, "name": "connectionAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.ConnectionAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 129 }, "name": "connectionAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 134 }, "name": "connectionsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 136 }, "name": "cpuUsageMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 144 }, "name": "deleteLatencyMetrics", "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 135 }, "name": "diskSpaceUsageMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 142 }, "name": "insertLatencyMetrics", "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 132 }, "name": "iopsAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 127 }, "name": "latencyAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 146 }, "name": "latencyTypesToRender", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 137 }, "name": "readIopsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 130 }, "name": "readLatencyAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 141 }, "name": "selectLatencyMetrics", "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 122 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 143 }, "name": "updateLatencyMetrics", "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 125 }, "name": "usageAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.UsageAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 128 }, "name": "usageAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 138 }, "name": "writeIopsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 131 }, "name": "writeLatencyAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 123 }, "name": "url", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-rds/RdsClusterMonitoring:RdsClusterMonitoring" }, "cdk-monitoring-constructs.RdsClusterMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RdsClusterMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 43 }, "name": "RdsClusterMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 105 }, "name": "addCommitLatencyAverageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 104 }, "name": "addCommitLatencyP100Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 97 }, "name": "addCommitLatencyP50Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 98 }, "name": "addCommitLatencyP70Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 99 }, "name": "addCommitLatencyP90Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 100 }, "name": "addCommitLatencyP95Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 103 }, "name": "addCommitLatencyP9999Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 102 }, "name": "addCommitLatencyP999Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 101 }, "name": "addCommitLatencyP99Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 45 }, "name": "addCpuUsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 95 }, "name": "addDeleteLatencyAverageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 94 }, "name": "addDeleteLatencyP100Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 87 }, "name": "addDeleteLatencyP50Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 88 }, "name": "addDeleteLatencyP70Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 89 }, "name": "addDeleteLatencyP90Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 90 }, "name": "addDeleteLatencyP95Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 93 }, "name": "addDeleteLatencyP9999Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 92 }, "name": "addDeleteLatencyP999Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 91 }, "name": "addDeleteLatencyP99Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 44 }, "name": "addDiskSpaceUsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 75 }, "name": "addInsertLatencyAverageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 74 }, "name": "addInsertLatencyP100Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 67 }, "name": "addInsertLatencyP50Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 68 }, "name": "addInsertLatencyP70Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 69 }, "name": "addInsertLatencyP90Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 70 }, "name": "addInsertLatencyP95Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 73 }, "name": "addInsertLatencyP9999Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 72 }, "name": "addInsertLatencyP999Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 71 }, "name": "addInsertLatencyP99Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 50 }, "name": "addMaxConnectionCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.HighConnectionCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 46 }, "name": "addMinConnectionCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LowConnectionCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 54 }, "name": "addReadIOPSAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MaxUsageCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 65 }, "name": "addSelectLatencyAverageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 64 }, "name": "addSelectLatencyP100Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 57 }, "name": "addSelectLatencyP50Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 58 }, "name": "addSelectLatencyP70Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 59 }, "name": "addSelectLatencyP90Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 60 }, "name": "addSelectLatencyP95Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 63 }, "name": "addSelectLatencyP9999Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 62 }, "name": "addSelectLatencyP999Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 61 }, "name": "addSelectLatencyP99Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 85 }, "name": "addUpdateLatencyAverageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 84 }, "name": "addUpdateLatencyP100Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 77 }, "name": "addUpdateLatencyP50Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 78 }, "name": "addUpdateLatencyP70Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 79 }, "name": "addUpdateLatencyP90Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 80 }, "name": "addUpdateLatencyP95Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 83 }, "name": "addUpdateLatencyP9999Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 82 }, "name": "addUpdateLatencyP999Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 81 }, "name": "addUpdateLatencyP99Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 55 }, "name": "addWriteIOPSAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MaxUsageCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- p90 for all operation types", "remarks": "Note: any latency type with an alarm will be also added automatically.\nIf the list is undefined, default values will be shown.\nIf the list is empty, only the latency types with an alarm will be shown (if any).", "stability": "experimental", "summary": "You can specify what latency types you want to be rendered in the dashboards." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 114 }, "name": "latencyTypesToRender", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyType" }, "kind": "array" } } } ], "symbolId": "lib/monitoring/aws-rds/RdsClusterMonitoring:RdsClusterMonitoringOptions" }, "cdk-monitoring-constructs.RdsClusterMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RdsClusterMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.RdsClusterMetricFactoryProps", "cdk-monitoring-constructs.RdsClusterMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 117 }, "name": "RdsClusterMonitoringProps", "symbolId": "lib/monitoring/aws-rds/RdsClusterMonitoring:RdsClusterMonitoringProps" }, "cdk-monitoring-constructs.RdsInstanceAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RdsInstanceAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 145 }, "name": "RdsInstanceAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 146 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RdsInstanceMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:RdsInstanceAspectType" }, "cdk-monitoring-constructs.RdsInstanceMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RdsInstanceMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMetricFactory.ts", "line": 28 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.RdsInstanceMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMetricFactory.ts", "line": 23 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMetricFactory.ts", "line": 52 }, "name": "metricAverageCpuUsageInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMetricFactory.ts", "line": 74 }, "name": "metricAverageFreeableMemory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMetricFactory.ts", "line": 63 }, "name": "metricMaxFreeStorageSpace", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMetricFactory.ts", "line": 101 }, "name": "metricReadIops", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMetricFactory.ts", "line": 85 }, "name": "metricReadLatencyInMillis", "parameters": [ { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMetricFactory.ts", "line": 93 }, "name": "metricReadThroughput", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMetricFactory.ts", "line": 41 }, "name": "metricTotalConnectionCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMetricFactory.ts", "line": 128 }, "name": "metricWriteIops", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMetricFactory.ts", "line": 112 }, "name": "metricWriteLatencyInMillis", "parameters": [ { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMetricFactory.ts", "line": 120 }, "name": "metricWriteThroughput", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "RdsInstanceMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMetricFactory.ts", "line": 26 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMetricFactory.ts", "line": 25 }, "name": "instance", "type": { "fqn": "aws-cdk-lib.aws_rds.IDatabaseInstance" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMetricFactory.ts", "line": 24 }, "name": "instanceIdentifier", "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-rds/RdsInstanceMetricFactory:RdsInstanceMetricFactory" }, "cdk-monitoring-constructs.RdsInstanceMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RdsInstanceMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMetricFactory.ts", "line": 16 }, "name": "RdsInstanceMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "database instance." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMetricFactory.ts", "line": 20 }, "name": "instance", "type": { "fqn": "aws-cdk-lib.aws_rds.IDatabaseInstance" } } ], "symbolId": "lib/monitoring/aws-rds/RdsInstanceMetricFactory:RdsInstanceMetricFactoryProps" }, "cdk-monitoring-constructs.RdsInstanceMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RdsInstanceMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 74 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.RdsInstanceMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 54 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 204 }, "name": "createConnectionsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 189 }, "name": "createCpuAndDiskUsageWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 215 }, "name": "createLatencyWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 181 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 163 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 172 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "RdsInstanceMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 59 }, "name": "connectionAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.ConnectionAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 61 }, "name": "connectionAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 63 }, "name": "connectionsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 66 }, "name": "cpuUsageMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 65 }, "name": "freeableMemoryMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 64 }, "name": "freeStorageSpaceMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 69 }, "name": "readIopsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 67 }, "name": "readLatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 68 }, "name": "readThroughputMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 55 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 58 }, "name": "usageAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.UsageAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 60 }, "name": "usageAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 72 }, "name": "writeIopsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 70 }, "name": "writeLatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 71 }, "name": "writeThroughputMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 56 }, "name": "url", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-rds/RdsInstanceMonitoring:RdsInstanceMonitoring" }, "cdk-monitoring-constructs.RdsInstanceMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RdsInstanceMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 37 }, "name": "RdsInstanceMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 39 }, "name": "addCpuUsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 38 }, "name": "addFreeStorageSpaceAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MinUsageCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 44 }, "name": "addMaxConnectionCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.HighConnectionCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 40 }, "name": "addMinConnectionCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LowConnectionCountThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-rds/RdsInstanceMonitoring:RdsInstanceMonitoringOptions" }, "cdk-monitoring-constructs.RdsInstanceMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RdsInstanceMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.RdsInstanceMetricFactoryProps", "cdk-monitoring-constructs.RdsInstanceMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsInstanceMonitoring.ts", "line": 50 }, "name": "RdsInstanceMonitoringProps", "symbolId": "lib/monitoring/aws-rds/RdsInstanceMonitoring:RdsInstanceMonitoringProps" }, "cdk-monitoring-constructs.RecordsFailedThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RecordsFailedThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 24 }, "name": "RecordsFailedThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 25 }, "name": "maxRecordsFailedThreshold", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/KinesisAlarmFactory:RecordsFailedThreshold" }, "cdk-monitoring-constructs.RecordsThrottledThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RecordsThrottledThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 13 }, "name": "RecordsThrottledThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 14 }, "name": "maxRecordsThrottledThreshold", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/KinesisAlarmFactory:RecordsThrottledThreshold" }, "cdk-monitoring-constructs.RedshiftClusterAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RedshiftClusterAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 149 }, "name": "RedshiftClusterAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 150 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RedshiftClusterMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:RedshiftClusterAspectType" }, "cdk-monitoring-constructs.RedshiftClusterMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RedshiftClusterMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 22 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.RedshiftClusterMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 19 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 49 }, "name": "metricAverageCpuUsageInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 41 }, "name": "metricAverageDiskSpaceUsageInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 79 }, "name": "metricLongQueryDurationP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 92 }, "name": "metricMaintenanceModeEnabled", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 66 }, "name": "metricMediumQueryDurationP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 96 }, "name": "metricReadLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 53 }, "name": "metricShortQueryDurationP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 33 }, "name": "metricTotalConnectionCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 110 }, "name": "metricWriteLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "RedshiftClusterMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 20 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory:RedshiftClusterMetricFactory" }, "cdk-monitoring-constructs.RedshiftClusterMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RedshiftClusterMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 14 }, "name": "RedshiftClusterMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 16 }, "name": "clusterIdentifier", "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory:RedshiftClusterMetricFactoryProps" }, "cdk-monitoring-constructs.RedshiftClusterMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RedshiftClusterMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 79 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.RedshiftClusterMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 57 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 218 }, "name": "createConnectionsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 207 }, "name": "createCpuAndDiskUsageWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 244 }, "name": "createLatencyWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 254 }, "name": "createMaintenanceWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 229 }, "name": "createQueryDurationWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 199 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 179 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 188 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "RedshiftClusterMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 63 }, "name": "connectionAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.ConnectionAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 65 }, "name": "connectionAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 68 }, "name": "connectionsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 70 }, "name": "cpuUsageMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 69 }, "name": "diskSpaceUsageMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 62 }, "name": "latencyAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 73 }, "name": "longQueryDurationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 77 }, "name": "maintenanceModeMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 72 }, "name": "mediumQueryDurationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 64 }, "name": "queryDurationAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 74 }, "name": "readLatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 71 }, "name": "shortQueryDurationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 58 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 61 }, "name": "usageAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.UsageAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 66 }, "name": "usageAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 75 }, "name": "writeLatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 59 }, "name": "url", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring:RedshiftClusterMonitoring" }, "cdk-monitoring-constructs.RedshiftClusterMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RedshiftClusterMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 39 }, "name": "RedshiftClusterMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 41 }, "name": "addCpuUsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 40 }, "name": "addDiskSpaceUsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 47 }, "name": "addMaxConnectionCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.HighConnectionCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 42 }, "name": "addMaxLongQueryDurationAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DurationThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 43 }, "name": "addMinConnectionCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LowConnectionCountThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring:RedshiftClusterMonitoringOptions" }, "cdk-monitoring-constructs.RedshiftClusterMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RedshiftClusterMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.RedshiftClusterMetricFactoryProps", "cdk-monitoring-constructs.RedshiftClusterMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 53 }, "name": "RedshiftClusterMonitoringProps", "symbolId": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring:RedshiftClusterMonitoringProps" }, "cdk-monitoring-constructs.Route53HealthCheckMetricAdjuster": { "assembly": "cdk-monitoring-constructs", "docs": { "remarks": "The metric will be validated to ensure it satisfies Route53 Health Check alarm requirements, otherwise it will throw an {@link Error}.", "see": "https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/health-checks-types.html", "stability": "experimental", "summary": "Adjusts a metric so that alarms created from it can be used in Route53 Health Checks." }, "fqn": "cdk-monitoring-constructs.Route53HealthCheckMetricAdjuster", "initializer": { "docs": { "stability": "experimental" } }, "interfaces": [ "cdk-monitoring-constructs.IMetricAdjuster" ], "kind": "class", "locationInModule": { "filename": "lib/common/alarm/metric-adjuster/Route53HealthCheckMetricAdjuster.ts", "line": 25 }, "methods": [ { "docs": { "custom": { "inheritdoc": "true" }, "stability": "experimental", "summary": "Adjusts a metric." }, "locationInModule": { "filename": "lib/common/alarm/metric-adjuster/Route53HealthCheckMetricAdjuster.ts", "line": 29 }, "name": "adjustMetric", "overrides": "cdk-monitoring-constructs.IMetricAdjuster", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "alarmScope", "type": { "fqn": "constructs.Construct" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AddAlarmProps" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "Route53HealthCheckMetricAdjuster", "properties": [ { "const": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/metric-adjuster/Route53HealthCheckMetricAdjuster.ts", "line": 26 }, "name": "INSTANCE", "static": true, "type": { "fqn": "cdk-monitoring-constructs.Route53HealthCheckMetricAdjuster" } } ], "symbolId": "lib/common/alarm/metric-adjuster/Route53HealthCheckMetricAdjuster:Route53HealthCheckMetricAdjuster" }, "cdk-monitoring-constructs.RunningTaskCountThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RunningTaskCountThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 21 }, "name": "RunningTaskCountThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 22 }, "name": "maxRunningTasks", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/TaskHealthAlarmFactory:RunningTaskCountThreshold" }, "cdk-monitoring-constructs.RunningTaskRateThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RunningTaskRateThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 25 }, "name": "RunningTaskRateThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 26 }, "name": "maxRunningTaskRate", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/TaskHealthAlarmFactory:RunningTaskRateThreshold" }, "cdk-monitoring-constructs.S3BucketAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.S3BucketAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 153 }, "name": "S3BucketAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 154 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.S3BucketMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:S3BucketAspectType" }, "cdk-monitoring-constructs.S3BucketMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.S3BucketMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMetricFactory.ts", "line": 39 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.S3BucketMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMetricFactory.ts", "line": 36 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMetricFactory.ts", "line": 45 }, "name": "metricBucketSizeBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMetricFactory.ts", "line": 62 }, "name": "metricNumberOfObjects", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "S3BucketMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMetricFactory.ts", "line": 37 }, "name": "props", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.S3BucketMetricFactoryProps" } } ], "symbolId": "lib/monitoring/aws-s3/S3BucketMetricFactory:S3BucketMetricFactory" }, "cdk-monitoring-constructs.S3BucketMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.S3BucketMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMetricFactory.ts", "line": 31 }, "name": "S3BucketMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMetricFactory.ts", "line": 32 }, "name": "bucket", "type": { "fqn": "aws-cdk-lib.aws_s3.IBucket" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMetricFactory.ts", "line": 33 }, "name": "storageType", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.StorageType" } } ], "symbolId": "lib/monitoring/aws-s3/S3BucketMetricFactory:S3BucketMetricFactoryProps" }, "cdk-monitoring-constructs.S3BucketMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.S3BucketMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMonitoring.ts", "line": 37 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.S3BucketMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMonitoring.ts", "line": 30 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMonitoring.ts", "line": 59 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMonitoring.ts", "line": 86 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "S3BucketMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMonitoring.ts", "line": 34 }, "name": "bucketSizeBytesMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMonitoring.ts", "line": 35 }, "name": "numberOfObjectsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMonitoring.ts", "line": 31 }, "name": "title", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMonitoring.ts", "line": 32 }, "name": "url", "optional": true, "protected": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-s3/S3BucketMonitoring:S3BucketMonitoring" }, "cdk-monitoring-constructs.S3BucketMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.S3BucketMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMonitoring.ts", "line": 24 }, "name": "S3BucketMonitoringOptions", "symbolId": "lib/monitoring/aws-s3/S3BucketMonitoring:S3BucketMonitoringOptions" }, "cdk-monitoring-constructs.S3BucketMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.S3BucketMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.S3BucketMetricFactoryProps", "cdk-monitoring-constructs.S3BucketMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMonitoring.ts", "line": 26 }, "name": "S3BucketMonitoringProps", "symbolId": "lib/monitoring/aws-s3/S3BucketMonitoring:S3BucketMonitoringProps" }, "cdk-monitoring-constructs.ScaleAlarmsProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Properties for configuring a function that clones alarms to be scaled by multiplication factors." }, "fqn": "cdk-monitoring-constructs.ScaleAlarmsProps", "kind": "interface", "locationInModule": { "filename": "lib/common/alarm/ScaleAlarms.ts", "line": 18 }, "name": "ScaleAlarmsProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "The disambiguator to assign to the alarms cloned by the function." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/ScaleAlarms.ts", "line": 22 }, "name": "disambiguator", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- 1.0", "remarks": "When configured with a value less that 1.0, the cloned alarm *may* use a metric with a more\ngranular period so that the result will use a reasonable number of datapoints. In this case,\nthe `datapointsToAlarm` and `evaluationPeriods` are increased by the same factor that the\nperiod is decreased. It will also scale `threshold` for metrics using the SUM or SAMPLE_COUNT\nstats.", "stability": "experimental", "summary": "A multiplication factor to apply to the datapointsToAlarm property of the cloned alarms." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/ScaleAlarms.ts", "line": 44 }, "name": "datapointsToAlarmMultiplier", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- Same as datapointsToAlarmMultiplier.", "stability": "experimental", "summary": "A multiplication factor to apply to the `evaluationPeriods` property of the cloned alarms." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/ScaleAlarms.ts", "line": 50 }, "name": "evaluationPeriodsMultiplier", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- 1.0", "remarks": "Threshold scaling does not apply to thresholds on anomaly detection alarms.", "stability": "experimental", "summary": "A multiplication factor to apply to the threshold of the cloned alarms." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/ScaleAlarms.ts", "line": 31 }, "name": "thresholdMultiplier", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/common/alarm/ScaleAlarms:ScaleAlarmsProps" }, "cdk-monitoring-constructs.SecretsManagerAlarmFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SecretsManagerAlarmFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/SecretsManagerAlarmFactory.ts", "line": 29 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/SecretsManagerAlarmFactory.ts", "line": 26 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/SecretsManagerAlarmFactory.ts", "line": 73 }, "name": "addChangeInSecretCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.ChangeInSecretCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/SecretsManagerAlarmFactory.ts", "line": 53 }, "name": "addMaxSecretCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MaxSecretCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/SecretsManagerAlarmFactory.ts", "line": 33 }, "name": "addMinSecretCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MinSecretCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } } ], "name": "SecretsManagerAlarmFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/SecretsManagerAlarmFactory.ts", "line": 27 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ], "symbolId": "lib/common/monitoring/alarms/SecretsManagerAlarmFactory:SecretsManagerAlarmFactory" }, "cdk-monitoring-constructs.SecretsManagerMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SecretsManagerMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerMetricFactory.ts", "line": 20 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.BaseMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerMetricFactory.ts", "line": 19 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerMetricFactory.ts", "line": 27 }, "name": "metricSecretCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "SecretsManagerMetricFactory", "symbolId": "lib/monitoring/aws-secretsmanager/SecretsManagerMetricFactory:SecretsManagerMetricFactory" }, "cdk-monitoring-constructs.SecretsManagerMetricsPublisher": { "assembly": "cdk-monitoring-constructs", "base": "constructs.Construct", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SecretsManagerMetricsPublisher", "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerMetricsPublisher.ts", "line": 20 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerMetricsPublisher.ts", "line": 72 }, "name": "getInstance", "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.SecretsManagerMetricsPublisher" } }, "static": true }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerMetricsPublisher.ts", "line": 83 }, "name": "addSecret", "parameters": [ { "name": "secret", "type": { "fqn": "aws-cdk-lib.aws_secretsmanager.ISecret" } } ] } ], "name": "SecretsManagerMetricsPublisher", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerMetricsPublisher.ts", "line": 22 }, "name": "lambda", "type": { "fqn": "aws-cdk-lib.aws_lambda.IFunction" } } ], "symbolId": "lib/monitoring/aws-secretsmanager/SecretsManagerMetricsPublisher:SecretsManagerMetricsPublisher" }, "cdk-monitoring-constructs.SecretsManagerMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SecretsManagerMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerMonitoring.ts", "line": 47 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.SecretsManagerMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerMonitoring.ts", "line": 39 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerMonitoring.ts", "line": 130 }, "name": "createSecretsCountWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerMonitoring.ts", "line": 123 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerMonitoring.ts", "line": 109 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerMonitoring.ts", "line": 116 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "SecretsManagerMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerMonitoring.ts", "line": 43 }, "name": "secretsCountAnnotation", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerMonitoring.ts", "line": 45 }, "name": "secretsCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerMonitoring.ts", "line": 42 }, "name": "secretsManagerAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.SecretsManagerAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerMonitoring.ts", "line": 40 }, "name": "title", "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-secretsmanager/SecretsManagerMonitoring:SecretsManagerMonitoring" }, "cdk-monitoring-constructs.SecretsManagerMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SecretsManagerMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerMonitoring.ts", "line": 27 }, "name": "SecretsManagerMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerMonitoring.ts", "line": 30 }, "name": "addChangeInSecretsAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ChangeInSecretCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerMonitoring.ts", "line": 29 }, "name": "addMaxNumberSecretsAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MaxSecretCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerMonitoring.ts", "line": 28 }, "name": "addMinNumberSecretsAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MinSecretCountThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-secretsmanager/SecretsManagerMonitoring:SecretsManagerMonitoringOptions" }, "cdk-monitoring-constructs.SecretsManagerMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SecretsManagerMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.SecretsManagerMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerMonitoring.ts", "line": 36 }, "name": "SecretsManagerMonitoringProps", "symbolId": "lib/monitoring/aws-secretsmanager/SecretsManagerMonitoring:SecretsManagerMonitoringProps" }, "cdk-monitoring-constructs.SecretsManagerSecretAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SecretsManagerSecretAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 157 }, "name": "SecretsManagerSecretAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 159 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.SecretsManagerSecretMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:SecretsManagerSecretAspectType" }, "cdk-monitoring-constructs.SecretsManagerSecretMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SecretsManagerSecretMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMetricFactory.ts", "line": 23 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.SecretsManagerSecretMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMetricFactory.ts", "line": 16 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMetricFactory.ts", "line": 35 }, "name": "metricDaysSinceLastChange", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMetricFactory.ts", "line": 49 }, "name": "metricDaysSinceLastRotation", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "SecretsManagerSecretMetricFactory", "properties": [ { "const": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMetricFactory.ts", "line": 18 }, "name": "MetricNameDaysSinceLastChange", "static": true, "type": { "primitive": "string" } }, { "const": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMetricFactory.ts", "line": 19 }, "name": "MetricNameDaysSinceLastRotation", "static": true, "type": { "primitive": "string" } }, { "const": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMetricFactory.ts", "line": 17 }, "name": "Namespace", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMetricFactory.ts", "line": 20 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMetricFactory.ts", "line": 21 }, "name": "secret", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_secretsmanager.ISecret" } } ], "symbolId": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMetricFactory:SecretsManagerSecretMetricFactory" }, "cdk-monitoring-constructs.SecretsManagerSecretMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SecretsManagerSecretMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMetricFactory.ts", "line": 11 }, "name": "SecretsManagerSecretMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMetricFactory.ts", "line": 13 }, "name": "secret", "type": { "fqn": "aws-cdk-lib.aws_secretsmanager.ISecret" } } ], "symbolId": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMetricFactory:SecretsManagerSecretMetricFactoryProps" }, "cdk-monitoring-constructs.SecretsManagerSecretMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SecretsManagerSecretMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring.ts", "line": 73 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.SecretsManagerSecretMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring.ts", "line": 64 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring.ts", "line": 133 }, "name": "createDaysSinceLastChangeWidget", "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring.ts", "line": 144 }, "name": "createDaysSinceLastRotationWidget", "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring.ts", "line": 155 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring.ts", "line": 175 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring.ts", "line": 162 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "SecretsManagerSecretMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring.ts", "line": 67 }, "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring.ts", "line": 69 }, "name": "daysSinceLastChangeAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring.ts", "line": 68 }, "name": "daysSinceLastChangeMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring.ts", "line": 71 }, "name": "daysSinceLastRotationAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring.ts", "line": 70 }, "name": "daysSinceLastRotationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring.ts", "line": 66 }, "name": "showLastRotationWidget", "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring.ts", "line": 65 }, "name": "title", "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring:SecretsManagerSecretMonitoring" }, "cdk-monitoring-constructs.SecretsManagerSecretMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SecretsManagerSecretMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring.ts", "line": 34 }, "name": "SecretsManagerSecretMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring.ts", "line": 36 }, "name": "addDaysSinceLastChangeAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DaysSinceUpdateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring.ts", "line": 40 }, "name": "addDaysSinceLastRotationAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DaysSinceUpdateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- true, if `addDaysSinceLastRotationAlarm` is set, otherwise `false`.", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring.ts", "line": 48 }, "name": "showLastRotationWidget", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "This may be useful if you want to monitor the function itself.", "stability": "experimental", "summary": "Provides access to the underlying metrics publisher Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring.ts", "line": 54 }, "name": "usePublisher", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.IPublisherConsumer" } } ], "symbolId": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring:SecretsManagerSecretMonitoringOptions" }, "cdk-monitoring-constructs.SecretsManagerSecretMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Monitoring props for Secrets Manager secrets." }, "fqn": "cdk-monitoring-constructs.SecretsManagerSecretMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.SecretsManagerSecretMetricFactoryProps", "cdk-monitoring-constructs.SecretsManagerSecretMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring.ts", "line": 60 }, "name": "SecretsManagerSecretMonitoringProps", "symbolId": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring:SecretsManagerSecretMonitoringProps" }, "cdk-monitoring-constructs.SimpleEc2ServiceMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Monitoring props for Simple EC2 service." }, "fqn": "cdk-monitoring-constructs.SimpleEc2ServiceMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps", "cdk-monitoring-constructs.BaseEc2ServiceAlarms" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 91 }, "name": "SimpleEc2ServiceMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 93 }, "name": "ec2Service", "type": { "fqn": "aws-cdk-lib.aws_ecs.Ec2Service" } } ], "symbolId": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring:SimpleEc2ServiceMonitoringProps" }, "cdk-monitoring-constructs.SimpleFargateServiceMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental", "summary": "Monitoring props for Simple Fargate service." }, "fqn": "cdk-monitoring-constructs.SimpleFargateServiceMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.BaseFargateServiceMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 91 }, "name": "SimpleFargateServiceMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 93 }, "name": "fargateService", "type": { "fqn": "aws-cdk-lib.aws_ecs.FargateService" } } ], "symbolId": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring:SimpleFargateServiceMonitoringProps" }, "cdk-monitoring-constructs.SingleAxisGraphWidget": { "assembly": "cdk-monitoring-constructs", "base": "aws-cdk-lib.aws_cloudwatch.GraphWidget", "docs": { "remarks": "If there is just one metric, it will hide the legend to save space.\nThe purpose of this custom class is to make the properties more strict.\nIt will avoid graphs with undefined axis and dimensions.", "stability": "experimental", "summary": "Line graph widget with one axis only (left)." }, "fqn": "cdk-monitoring-constructs.SingleAxisGraphWidget", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 28 }, "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.SingleAxisGraphWidgetProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 27 }, "name": "SingleAxisGraphWidget", "symbolId": "lib/dashboard/widget/StrictGraphWidget:SingleAxisGraphWidget" }, "cdk-monitoring-constructs.SingleAxisGraphWidgetProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SingleAxisGraphWidgetProps", "kind": "interface", "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 11 }, "name": "SingleAxisGraphWidgetProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 14 }, "name": "height", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 16 }, "name": "leftAxis", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.YAxisProps" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 15 }, "name": "leftMetrics", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 13 }, "name": "width", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 17 }, "name": "leftAnnotations", "optional": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 12 }, "name": "title", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 18 }, "name": "verticalAnnotations", "optional": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.VerticalAnnotation" }, "kind": "array" } } } ], "symbolId": "lib/dashboard/widget/StrictGraphWidget:SingleAxisGraphWidgetProps" }, "cdk-monitoring-constructs.SingleWidgetDashboardSegment": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SingleWidgetDashboardSegment", "initializer": { "docs": { "stability": "experimental", "summary": "Create a dashboard segment representing a single widget." }, "locationInModule": { "filename": "lib/dashboard/SingleWidgetDashboardSegment.ts", "line": 17 }, "parameters": [ { "docs": { "summary": "widget to add." }, "name": "widget", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" } }, { "docs": { "remarks": "Defaults to the default dashboards.", "summary": "list of dashboard names which to show this widget on." }, "name": "dashboardsToInclude", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ] }, "interfaces": [ "cdk-monitoring-constructs.IDashboardSegment", "cdk-monitoring-constructs.IDynamicDashboardSegment" ], "kind": "class", "locationInModule": { "filename": "lib/dashboard/SingleWidgetDashboardSegment.ts", "line": 6 }, "methods": [ { "docs": { "remarks": "These should go to the runbook or service dashboard.", "stability": "experimental", "summary": "Returns widgets for all alarms." }, "locationInModule": { "filename": "lib/dashboard/SingleWidgetDashboardSegment.ts", "line": 34 }, "name": "alarmWidgets", "overrides": "cdk-monitoring-constructs.IDashboardSegment", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "remarks": "These should go to the team OPS dashboard.", "stability": "experimental", "summary": "Returns widgets for the summary." }, "locationInModule": { "filename": "lib/dashboard/SingleWidgetDashboardSegment.ts", "line": 42 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.IDashboardSegment", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "remarks": "These should go to the detailed service dashboard.", "stability": "experimental", "summary": "Returns all widgets." }, "locationInModule": { "filename": "lib/dashboard/SingleWidgetDashboardSegment.ts", "line": 50 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.IDashboardSegment", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets for the requested dashboard type." }, "locationInModule": { "filename": "lib/dashboard/SingleWidgetDashboardSegment.ts", "line": 26 }, "name": "widgetsForDashboard", "overrides": "cdk-monitoring-constructs.IDynamicDashboardSegment", "parameters": [ { "name": "name", "type": { "primitive": "string" } } ], "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "SingleWidgetDashboardSegment", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/SingleWidgetDashboardSegment.ts", "line": 10 }, "name": "dashboardsToInclude", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/SingleWidgetDashboardSegment.ts", "line": 9 }, "name": "widget", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" } } ], "symbolId": "lib/dashboard/SingleWidgetDashboardSegment:SingleWidgetDashboardSegment" }, "cdk-monitoring-constructs.SnsAlarmActionStrategy": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental", "summary": "Alarm action strategy that sends a notification to the specified SNS topic." }, "fqn": "cdk-monitoring-constructs.SnsAlarmActionStrategy", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/action/SnsAlarmActionStrategy.ts", "line": 50 }, "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.SnsAlarmActionStrategyProps" } } ] }, "interfaces": [ "cdk-monitoring-constructs.IAlarmActionStrategy" ], "kind": "class", "locationInModule": { "filename": "lib/common/alarm/action/SnsAlarmActionStrategy.ts", "line": 45 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/action/SnsAlarmActionStrategy.ts", "line": 56 }, "name": "addAlarmActions", "overrides": "cdk-monitoring-constructs.IAlarmActionStrategy", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmActionStrategyProps" } } ] } ], "name": "SnsAlarmActionStrategy", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/action/SnsAlarmActionStrategy.ts", "line": 46 }, "name": "onAlarmTopic", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_sns.ITopic" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/action/SnsAlarmActionStrategy.ts", "line": 48 }, "name": "onInsufficientDataTopic", "optional": true, "protected": true, "type": { "fqn": "aws-cdk-lib.aws_sns.ITopic" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/action/SnsAlarmActionStrategy.ts", "line": 47 }, "name": "onOkTopic", "optional": true, "protected": true, "type": { "fqn": "aws-cdk-lib.aws_sns.ITopic" } } ], "symbolId": "lib/common/alarm/action/SnsAlarmActionStrategy:SnsAlarmActionStrategy" }, "cdk-monitoring-constructs.SnsAlarmActionStrategyProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SnsAlarmActionStrategyProps", "kind": "interface", "locationInModule": { "filename": "lib/common/alarm/action/SnsAlarmActionStrategy.ts", "line": 21 }, "name": "SnsAlarmActionStrategyProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Target topic used when the alarm is triggered." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/action/SnsAlarmActionStrategy.ts", "line": 25 }, "name": "onAlarmTopic", "type": { "fqn": "aws-cdk-lib.aws_sns.ITopic" } }, { "abstract": true, "docs": { "default": "- no notification sent", "stability": "experimental", "summary": "Optional target topic for when the alarm goes into the INSUFFICIENT_DATA state." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/action/SnsAlarmActionStrategy.ts", "line": 39 }, "name": "onInsufficientDataTopic", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_sns.ITopic" } }, { "abstract": true, "docs": { "default": "- no notification sent", "stability": "experimental", "summary": "Optional target topic for when the alarm goes into the OK state." }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/action/SnsAlarmActionStrategy.ts", "line": 32 }, "name": "onOkTopic", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_sns.ITopic" } } ], "symbolId": "lib/common/alarm/action/SnsAlarmActionStrategy:SnsAlarmActionStrategyProps" }, "cdk-monitoring-constructs.SnsTopicAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SnsTopicAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 162 }, "name": "SnsTopicAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 163 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.SnsTopicMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:SnsTopicAspectType" }, "cdk-monitoring-constructs.SnsTopicMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SnsTopicMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMetricFactory.ts", "line": 16 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.SnsTopicMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMetricFactory.ts", "line": 13 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMetricFactory.ts", "line": 42 }, "name": "metricAverageMessageSizeInBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMetricFactory.ts", "line": 22 }, "name": "metricIncomingMessageCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMetricFactory.ts", "line": 52 }, "name": "metricNumberOfNotificationsFailed", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMetricFactory.ts", "line": 32 }, "name": "metricOutgoingMessageCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "SnsTopicMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMetricFactory.ts", "line": 14 }, "name": "topic", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_sns.ITopic" } } ], "symbolId": "lib/monitoring/aws-sns/SnsTopicMetricFactory:SnsTopicMetricFactory" }, "cdk-monitoring-constructs.SnsTopicMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SnsTopicMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMetricFactory.ts", "line": 9 }, "name": "SnsTopicMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMetricFactory.ts", "line": 10 }, "name": "topic", "type": { "fqn": "aws-cdk-lib.aws_sns.ITopic" } } ], "symbolId": "lib/monitoring/aws-sns/SnsTopicMetricFactory:SnsTopicMetricFactoryProps" }, "cdk-monitoring-constructs.SnsTopicMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SnsTopicMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 65 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.SnsTopicMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 52 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 161 }, "name": "createMessageCountWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 182 }, "name": "createMessageFailedWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 172 }, "name": "createMessageSizeWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 153 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 136 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 144 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "SnsTopicMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 57 }, "name": "failedDeliveryAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 58 }, "name": "incomingMessagesAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 60 }, "name": "incomingMessagesMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 63 }, "name": "messagesFailedMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 62 }, "name": "messageSizeMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 61 }, "name": "outgoingMessagesMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 53 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 56 }, "name": "topicAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.TopicAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 54 }, "name": "topicUrl", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-sns/SnsTopicMonitoring:SnsTopicMonitoring" }, "cdk-monitoring-constructs.SnsTopicMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SnsTopicMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 33 }, "name": "SnsTopicMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 42 }, "name": "addMaxNumberOfMessagesPublishedAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.HighMessagesPublishedThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 34 }, "name": "addMessageNotificationsFailedAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.NotificationsFailedThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 38 }, "name": "addMinNumberOfMessagesPublishedAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LowMessagesPublishedThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-sns/SnsTopicMonitoring:SnsTopicMonitoringOptions" }, "cdk-monitoring-constructs.SnsTopicMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SnsTopicMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.SnsTopicMetricFactoryProps", "cdk-monitoring-constructs.SnsTopicMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 48 }, "name": "SnsTopicMonitoringProps", "symbolId": "lib/monitoring/aws-sns/SnsTopicMonitoring:SnsTopicMonitoringProps" }, "cdk-monitoring-constructs.SqsQueueAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SqsQueueAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 166 }, "name": "SqsQueueAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 167 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.SqsQueueMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:SqsQueueAspectType" }, "cdk-monitoring-constructs.SqsQueueMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SqsQueueMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 17 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.SqsQueueMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 14 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 55 }, "name": "metricApproximateAgeOfOldestMessageInSeconds", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 23 }, "name": "metricApproximateVisibleMessageCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 65 }, "name": "metricAverageMessageSizeInBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 85 }, "name": "metricConsumptionRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 44 }, "name": "metricDeletedMessageCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 33 }, "name": "metricIncomingMessageCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 75 }, "name": "metricProductionRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 97 }, "name": "metricTimeToDrain", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "SqsQueueMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 15 }, "name": "queue", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_sqs.IQueue" } } ], "symbolId": "lib/monitoring/aws-sqs/SqsQueueMetricFactory:SqsQueueMetricFactory" }, "cdk-monitoring-constructs.SqsQueueMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SqsQueueMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 10 }, "name": "SqsQueueMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 11 }, "name": "queue", "type": { "fqn": "aws-cdk-lib.aws_sqs.IQueue" } } ], "symbolId": "lib/monitoring/aws-sqs/SqsQueueMetricFactory:SqsQueueMetricFactoryProps" }, "cdk-monitoring-constructs.SqsQueueMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SqsQueueMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 83 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.SqsQueueMonitoringProps" } }, { "name": "invokedFromSuper", "optional": true, "type": { "primitive": "boolean" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 65 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 249 }, "name": "createMessageAgeWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 238 }, "name": "createMessageCountWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 260 }, "name": "createMessageSizeWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 270 }, "name": "createProducerAndConsumerRateWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 280 }, "name": "createTimeToDrainWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 230 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 290 }, "name": "resolveQueueName", "parameters": [ { "name": "queue", "type": { "fqn": "aws-cdk-lib.aws_sqs.IQueue" } } ], "protected": true, "returns": { "optional": true, "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 195 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 212 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "SqsQueueMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 71 }, "name": "ageAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 80 }, "name": "consumptionRateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 70 }, "name": "countAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 76 }, "name": "deletedMessagesMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 75 }, "name": "incomingMessagesMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 78 }, "name": "messageSizeMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 77 }, "name": "oldestMessageAgeMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 79 }, "name": "productionRateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 69 }, "name": "queueAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.QueueAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 72 }, "name": "timeToDrainAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 81 }, "name": "timeToDrainMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 66 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 74 }, "name": "visibleMessagesMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 67 }, "name": "queueUrl", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-sqs/SqsQueueMonitoring:SqsQueueMonitoring" }, "cdk-monitoring-constructs.SqsQueueMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SqsQueueMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseSqsQueueAlarms", "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 57 }, "name": "SqsQueueMonitoringOptions", "symbolId": "lib/monitoring/aws-sqs/SqsQueueMonitoring:SqsQueueMonitoringOptions" }, "cdk-monitoring-constructs.SqsQueueMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SqsQueueMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.SqsQueueMetricFactoryProps", "cdk-monitoring-constructs.SqsQueueMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 61 }, "name": "SqsQueueMonitoringProps", "symbolId": "lib/monitoring/aws-sqs/SqsQueueMonitoring:SqsQueueMonitoringProps" }, "cdk-monitoring-constructs.SqsQueueMonitoringWithDlq": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.SqsQueueMonitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SqsQueueMonitoringWithDlq", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts", "line": 82 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.SqsQueueMonitoringWithDlqProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts", "line": 69 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts", "line": 218 }, "name": "createDeadLetterMessageAgeWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts", "line": 204 }, "name": "createDeadLetterMessageCountWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts", "line": 196 }, "name": "createDeadLetterTitleWidget", "protected": true, "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts", "line": 160 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.SqsQueueMonitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts", "line": 181 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.SqsQueueMonitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "SqsQueueMonitoringWithDlq", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts", "line": 72 }, "name": "addDeadLetterQueueToSummaryDashboard", "protected": true, "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts", "line": 76 }, "name": "deadLetterAgeAnnotations", "protected": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts", "line": 75 }, "name": "deadLetterCountAnnotations", "protected": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts", "line": 74 }, "name": "deadLetterQueueAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.QueueAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts", "line": 79 }, "name": "deadLetterQueueIncomingMessagesMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts", "line": 80 }, "name": "deadLetterQueueOldestMessageAgeMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts", "line": 78 }, "name": "deadLetterQueueVisibleMessagesMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts", "line": 70 }, "name": "deadLetterTitle", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts", "line": 71 }, "name": "deadLetterUrl", "optional": true, "protected": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq:SqsQueueMonitoringWithDlq" }, "cdk-monitoring-constructs.SqsQueueMonitoringWithDlqProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SqsQueueMonitoringWithDlqProps", "interfaces": [ "cdk-monitoring-constructs.SqsQueueMonitoringProps", "cdk-monitoring-constructs.BaseDlqAlarms" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts", "line": 56 }, "name": "SqsQueueMonitoringWithDlqProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts", "line": 59 }, "name": "deadLetterQueue", "type": { "fqn": "aws-cdk-lib.aws_sqs.IQueue" } }, { "abstract": true, "docs": { "default": "- true", "stability": "experimental", "summary": "Indicates whether the DLQ monitoring should be added to summary dashboard." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts", "line": 66 }, "name": "addDeadLetterQueueToSummaryDashboard", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq:SqsQueueMonitoringWithDlqProps" }, "cdk-monitoring-constructs.StaticSegmentDynamicAdapter": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StaticSegmentDynamicAdapter", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/DynamicDashboardSegment.ts", "line": 16 }, "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.IDashboardFactoryProps" } } ] }, "interfaces": [ "cdk-monitoring-constructs.IDynamicDashboardSegment" ], "kind": "class", "locationInModule": { "filename": "lib/dashboard/DynamicDashboardSegment.ts", "line": 13 }, "methods": [ { "docs": { "remarks": "The default values are true, so consumers must set these to false if they would\nlike to hide these items from dashboards", "stability": "experimental", "summary": "Adapts an IDashboardSegment to the IDynamicDashboardSegment interface by using overrideProps to determine if a segment should be shown on a specific dashboard." }, "locationInModule": { "filename": "lib/dashboard/DynamicDashboardSegment.ts", "line": 26 }, "name": "widgetsForDashboard", "overrides": "cdk-monitoring-constructs.IDynamicDashboardSegment", "parameters": [ { "name": "name", "type": { "primitive": "string" } } ], "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "StaticSegmentDynamicAdapter", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DynamicDashboardSegment.ts", "line": 14 }, "name": "props", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.IDashboardFactoryProps" } } ], "symbolId": "lib/dashboard/DynamicDashboardSegment:StaticSegmentDynamicAdapter" }, "cdk-monitoring-constructs.StepFunctionActivityMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StepFunctionActivityMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 27 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.StepFunctionActivityMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 23 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 165 }, "name": "metricActivitiesFailed", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 179 }, "name": "metricActivitiesFailedRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 189 }, "name": "metricActivitiesHeartbeatTimedOut", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 203 }, "name": "metricActivitiesScheduled", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 217 }, "name": "metricActivitiesStarted", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 231 }, "name": "metricActivitiesSucceeded", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 245 }, "name": "metricActivitiesTimedOut", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 67 }, "name": "metricActivityRunTimeP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 53 }, "name": "metricActivityRunTimeP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 39 }, "name": "metricActivityRunTimeP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 109 }, "name": "metricActivityScheduleTimeP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 95 }, "name": "metricActivityScheduleTimeP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 81 }, "name": "metricActivityScheduleTimeP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 151 }, "name": "metricActivityTimeP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 137 }, "name": "metricActivityTimeP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 123 }, "name": "metricActivityTimeP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "StepFunctionActivityMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 25 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 24 }, "name": "rateComputationMethod", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory:StepFunctionActivityMetricFactory" }, "cdk-monitoring-constructs.StepFunctionActivityMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StepFunctionActivityMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 14 }, "name": "StepFunctionActivityMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 16 }, "name": "activity", "type": { "fqn": "aws-cdk-lib.aws_stepfunctions.IActivity" } }, { "abstract": true, "docs": { "default": "- average", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 20 }, "name": "rateComputationMethod", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory:StepFunctionActivityMetricFactoryProps" }, "cdk-monitoring-constructs.StepFunctionActivityMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StepFunctionActivityMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 71 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.StepFunctionActivityMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 50 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 181 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 220 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "StepFunctionActivityMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 54 }, "name": "durationAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 56 }, "name": "durationAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 53 }, "name": "errorAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 57 }, "name": "errorCountAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 58 }, "name": "errorRateAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 66 }, "name": "failedActivitiesMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 67 }, "name": "failedActivitiesRateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 68 }, "name": "heartbeatTimedOutActivitiesMetrics", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 60 }, "name": "p50DurationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 61 }, "name": "p90DurationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 62 }, "name": "p99DurationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 63 }, "name": "scheduledActivitiesMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 64 }, "name": "startedActivitiesMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 65 }, "name": "succeededActivitiesMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 69 }, "name": "timedOutActivitiesMetrics", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 51 }, "name": "title", "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring:StepFunctionActivityMonitoring" }, "cdk-monitoring-constructs.StepFunctionActivityMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StepFunctionActivityMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.StepFunctionActivityMetricFactoryProps", "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 35 }, "name": "StepFunctionActivityMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 38 }, "name": "addDurationP50Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DurationThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 39 }, "name": "addDurationP90Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DurationThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 40 }, "name": "addDurationP99Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DurationThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 42 }, "name": "addFailedActivitiesCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 43 }, "name": "addFailedActivitiesRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 44 }, "name": "addTimedOutActivitiesCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring:StepFunctionActivityMonitoringProps" }, "cdk-monitoring-constructs.StepFunctionAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StepFunctionAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 170 }, "name": "StepFunctionAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 171 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.StepFunctionMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:StepFunctionAspectType" }, "cdk-monitoring-constructs.StepFunctionLambdaIntegrationMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StepFunctionLambdaIntegrationMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 27 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.StepFunctionLambdaIntegrationMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 23 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 67 }, "name": "metricFunctionRunTimeP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 53 }, "name": "metricFunctionRunTimeP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 39 }, "name": "metricFunctionRunTimeP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 109 }, "name": "metricFunctionScheduleTimeP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 95 }, "name": "metricFunctionScheduleTimeP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 81 }, "name": "metricFunctionScheduleTimeP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 165 }, "name": "metricFunctionsFailed", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 179 }, "name": "metricFunctionsFailedRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 188 }, "name": "metricFunctionsScheduled", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 202 }, "name": "metricFunctionsStarted", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 216 }, "name": "metricFunctionsSucceeded", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 230 }, "name": "metricFunctionsTimedOut", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 151 }, "name": "metricFunctionTimeP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 137 }, "name": "metricFunctionTimeP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 123 }, "name": "metricFunctionTimeP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "StepFunctionLambdaIntegrationMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 25 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 24 }, "name": "rateComputationMethod", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory:StepFunctionLambdaIntegrationMetricFactory" }, "cdk-monitoring-constructs.StepFunctionLambdaIntegrationMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StepFunctionLambdaIntegrationMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 14 }, "name": "StepFunctionLambdaIntegrationMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 16 }, "name": "lambdaFunction", "type": { "fqn": "aws-cdk-lib.aws_lambda.IFunction" } }, { "abstract": true, "docs": { "default": "- average", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 20 }, "name": "rateComputationMethod", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory:StepFunctionLambdaIntegrationMetricFactoryProps" }, "cdk-monitoring-constructs.StepFunctionLambdaIntegrationMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StepFunctionLambdaIntegrationMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 69 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.StepFunctionLambdaIntegrationMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 48 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 179 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 218 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "StepFunctionLambdaIntegrationMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 53 }, "name": "durationAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 55 }, "name": "durationAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 52 }, "name": "errorAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 56 }, "name": "errorCountAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 57 }, "name": "errorRateAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 66 }, "name": "failedFunctionRateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 65 }, "name": "failedFunctionsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 59 }, "name": "p50DurationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 60 }, "name": "p90DurationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 61 }, "name": "p99DurationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 62 }, "name": "scheduledFunctionsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 63 }, "name": "startedFunctionsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 64 }, "name": "succeededFunctionsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 67 }, "name": "timedOutFunctionsMetrics", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 49 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 50 }, "name": "functionUrl", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring:StepFunctionLambdaIntegrationMonitoring" }, "cdk-monitoring-constructs.StepFunctionLambdaIntegrationMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StepFunctionLambdaIntegrationMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.StepFunctionLambdaIntegrationMetricFactoryProps", "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 36 }, "name": "StepFunctionLambdaIntegrationMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 39 }, "name": "addDurationP50Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DurationThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 40 }, "name": "addDurationP90Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DurationThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 41 }, "name": "addDurationP99Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DurationThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 43 }, "name": "addFailedFunctionsCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 44 }, "name": "addFailedFunctionsRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 45 }, "name": "addTimedOutFunctionsCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring:StepFunctionLambdaIntegrationMonitoringProps" }, "cdk-monitoring-constructs.StepFunctionMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StepFunctionMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 32 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.StepFunctionMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 28 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 137 }, "name": "metricExecutionsAborted", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 86 }, "name": "metricExecutionsFailed", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 100 }, "name": "metricExecutionsFailedRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 151 }, "name": "metricExecutionsStarted", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 165 }, "name": "metricExecutionsSucceeded", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 109 }, "name": "metricExecutionsTimedOut", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 123 }, "name": "metricExecutionThrottled", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 72 }, "name": "metricExecutionTimeP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 58 }, "name": "metricExecutionTimeP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 44 }, "name": "metricExecutionTimeP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "StepFunctionMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 30 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 29 }, "name": "rateComputationMethod", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory:StepFunctionMetricFactory" }, "cdk-monitoring-constructs.StepFunctionMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StepFunctionMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 20 }, "name": "StepFunctionMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 21 }, "name": "stateMachine", "type": { "fqn": "aws-cdk-lib.aws_stepfunctions.IStateMachine" } }, { "abstract": true, "docs": { "default": "- average", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 25 }, "name": "rateComputationMethod", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory:StepFunctionMetricFactoryProps" }, "cdk-monitoring-constructs.StepFunctionMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StepFunctionMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 85 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.StepFunctionMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 63 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 229 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 269 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "StepFunctionMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 81 }, "name": "abortedExecutionsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 68 }, "name": "durationAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 70 }, "name": "durationAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 67 }, "name": "errorAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 71 }, "name": "errorCountAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 72 }, "name": "errorRateAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 80 }, "name": "failedExecutionRateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 79 }, "name": "failedExecutionsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 74 }, "name": "p50DurationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 75 }, "name": "p90DurationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 76 }, "name": "p99DurationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 77 }, "name": "startedExecutionsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 78 }, "name": "succeededExecutionsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 69 }, "name": "taskHealthAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.TaskHealthAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 82 }, "name": "throttledExecutionsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 83 }, "name": "timedOutExecutionsMetrics", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 64 }, "name": "title", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 65 }, "name": "stateMachineUrl", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-step-functions/StepFunctionMonitoring:StepFunctionMonitoring" }, "cdk-monitoring-constructs.StepFunctionMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StepFunctionMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 37 }, "name": "StepFunctionMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 44 }, "name": "addAbortedExecutionCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 38 }, "name": "addDurationP50Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DurationThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 39 }, "name": "addDurationP90Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DurationThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 40 }, "name": "addDurationP99Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DurationThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 42 }, "name": "addFailedExecutionCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 43 }, "name": "addFailedExecutionRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Add minimum started execution count alarm for the stepfunctions." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 53 }, "name": "addMinStartedExecutionCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MinRunningTaskCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 45 }, "name": "addThrottledExecutionCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 49 }, "name": "addTimedOutExecutionCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-step-functions/StepFunctionMonitoring:StepFunctionMonitoringOptions" }, "cdk-monitoring-constructs.StepFunctionMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StepFunctionMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.StepFunctionMetricFactoryProps", "cdk-monitoring-constructs.StepFunctionMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 59 }, "name": "StepFunctionMonitoringProps", "symbolId": "lib/monitoring/aws-step-functions/StepFunctionMonitoring:StepFunctionMonitoringProps" }, "cdk-monitoring-constructs.StepFunctionServiceIntegrationMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StepFunctionServiceIntegrationMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 26 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.StepFunctionServiceIntegrationMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 22 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 66 }, "name": "metricServiceIntegrationRunTimeP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 52 }, "name": "metricServiceIntegrationRunTimeP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 38 }, "name": "metricServiceIntegrationRunTimeP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 108 }, "name": "metricServiceIntegrationScheduleTimeP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 94 }, "name": "metricServiceIntegrationScheduleTimeP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 80 }, "name": "metricServiceIntegrationScheduleTimeP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 164 }, "name": "metricServiceIntegrationsFailed", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 178 }, "name": "metricServiceIntegrationsFailedRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 187 }, "name": "metricServiceIntegrationsScheduled", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 201 }, "name": "metricServiceIntegrationsStarted", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 215 }, "name": "metricServiceIntegrationsSucceeded", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 229 }, "name": "metricServiceIntegrationsTimedOut", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 150 }, "name": "metricServiceIntegrationTimeP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 136 }, "name": "metricServiceIntegrationTimeP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 122 }, "name": "metricServiceIntegrationTimeP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "StepFunctionServiceIntegrationMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 24 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 23 }, "name": "rateComputationMethod", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory:StepFunctionServiceIntegrationMetricFactory" }, "cdk-monitoring-constructs.StepFunctionServiceIntegrationMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StepFunctionServiceIntegrationMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 13 }, "name": "StepFunctionServiceIntegrationMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 15 }, "name": "serviceIntegrationResourceArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- average", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 19 }, "name": "rateComputationMethod", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory:StepFunctionServiceIntegrationMetricFactoryProps" }, "cdk-monitoring-constructs.StepFunctionServiceIntegrationMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StepFunctionServiceIntegrationMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 76 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.StepFunctionServiceIntegrationMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 56 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 195 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 233 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "StepFunctionServiceIntegrationMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 60 }, "name": "durationAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 62 }, "name": "durationAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 59 }, "name": "errorAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 63 }, "name": "errorCountAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 64 }, "name": "errorRateAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 73 }, "name": "failedServiceIntegrationRateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 72 }, "name": "failedServiceIntegrationsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 66 }, "name": "p50DurationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 67 }, "name": "p90DurationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 68 }, "name": "p99DurationMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 69 }, "name": "scheduledServiceIntegrationsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 70 }, "name": "startedServiceIntegrationsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 71 }, "name": "succeededServiceIntegrationsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 74 }, "name": "timedOutServiceIntegrationsMetrics", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 57 }, "name": "title", "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring:StepFunctionServiceIntegrationMonitoring" }, "cdk-monitoring-constructs.StepFunctionServiceIntegrationMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StepFunctionServiceIntegrationMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.StepFunctionServiceIntegrationMetricFactoryProps", "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 35 }, "name": "StepFunctionServiceIntegrationMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 38 }, "name": "addDurationP50Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DurationThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 39 }, "name": "addDurationP90Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DurationThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 40 }, "name": "addDurationP99Alarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.DurationThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 42 }, "name": "addFailedServiceIntegrationsCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 46 }, "name": "addFailedServiceIntegrationsRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 50 }, "name": "addTimedOutServiceIntegrationsCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring:StepFunctionServiceIntegrationMonitoringProps" }, "cdk-monitoring-constructs.StorageType": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StorageType", "kind": "enum", "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMetricFactory.ts", "line": 12 }, "members": [ { "docs": { "stability": "experimental" }, "name": "DEEP_ARCHIVE_OBJECT_OVERHEAD" }, { "docs": { "stability": "experimental" }, "name": "DEEP_ARCHIVE_S3_OBJECT_OVERHEAD" }, { "docs": { "stability": "experimental" }, "name": "DEEP_ARCHIVE_STAGING_STORAGE" }, { "docs": { "stability": "experimental" }, "name": "DEEP_ARCHIVE_STORAGE" }, { "docs": { "stability": "experimental" }, "name": "GLACIER_OBJECT_OVERHEAD" }, { "docs": { "stability": "experimental" }, "name": "GLACIER_S3_OBJECT_OVERHEAD" }, { "docs": { "stability": "experimental" }, "name": "GLACIER_STAGING_STORAGE" }, { "docs": { "stability": "experimental" }, "name": "GLACIER_STORAGE" }, { "docs": { "stability": "experimental" }, "name": "INTELLIGENT_TIERING_FA_STORAGE" }, { "docs": { "stability": "experimental" }, "name": "INTELLIGENT_TIERING_IA_STORAGE" }, { "docs": { "stability": "experimental" }, "name": "ONE_ZONE_IA_SIZE_OVERHEAD" }, { "docs": { "stability": "experimental" }, "name": "ONE_ZONE_IA_STORAGE" }, { "docs": { "stability": "experimental" }, "name": "REDUCED_REDUNDANCY_STORAGE" }, { "docs": { "stability": "experimental" }, "name": "STANDARD_IA_SIZE_OVERHEAD" }, { "docs": { "stability": "experimental" }, "name": "STANDARD_IA_STORAGE" }, { "docs": { "stability": "experimental" }, "name": "STANDARD_STORAGE" } ], "name": "StorageType", "symbolId": "lib/monitoring/aws-s3/S3BucketMetricFactory:StorageType" }, "cdk-monitoring-constructs.SyntheticsCanaryAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SyntheticsCanaryAspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 174 }, "name": "SyntheticsCanaryAspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 175 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.SyntheticsCanaryMonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:SyntheticsCanaryAspectType" }, "cdk-monitoring-constructs.SyntheticsCanaryMetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SyntheticsCanaryMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 31 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.SyntheticsCanaryMetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 26 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 67 }, "name": "metric4xxErrorCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 81 }, "name": "metric4xxErrorRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 90 }, "name": "metric5xxFaultCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 104 }, "name": "metric5xxFaultRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 45 }, "name": "metricLatencyAverageInMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 56 }, "name": "metricSuccessInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "SyntheticsCanaryMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 27 }, "name": "canary", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_synthetics.Canary" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 29 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 28 }, "name": "rateComputationMethod", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory:SyntheticsCanaryMetricFactory" }, "cdk-monitoring-constructs.SyntheticsCanaryMetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SyntheticsCanaryMetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 13 }, "name": "SyntheticsCanaryMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "CloudWatch Canary to monitor." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 18 }, "name": "canary", "type": { "fqn": "aws-cdk-lib.aws_synthetics.Canary" } }, { "abstract": true, "docs": { "default": "- average", "stability": "experimental", "summary": "Method used to calculate relative rates." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 23 }, "name": "rateComputationMethod", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } } ], "symbolId": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory:SyntheticsCanaryMetricFactoryProps" }, "cdk-monitoring-constructs.SyntheticsCanaryMonitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html", "stability": "experimental", "summary": "Monitoring for CloudWatch Synthetics Canaries." }, "fqn": "cdk-monitoring-constructs.SyntheticsCanaryMonitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 68 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.SyntheticsCanaryMonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 53 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 191 }, "name": "createErrorCountWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 202 }, "name": "createErrorRateWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 180 }, "name": "createLatencyWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 173 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 156 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 164 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "SyntheticsCanaryMonitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 62 }, "name": "averageLatencyMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 57 }, "name": "errorAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 59 }, "name": "errorCountAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 63 }, "name": "errorCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 60 }, "name": "errorRateAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 64 }, "name": "errorRateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 65 }, "name": "faultCountMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 66 }, "name": "faultRateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 54 }, "name": "humanReadableName", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 56 }, "name": "latencyAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 58 }, "name": "latencyAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } } ], "symbolId": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring:SyntheticsCanaryMonitoring" }, "cdk-monitoring-constructs.SyntheticsCanaryMonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SyntheticsCanaryMonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 35 }, "name": "SyntheticsCanaryMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 36 }, "name": "add4xxErrorCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 37 }, "name": "add4xxErrorRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 38 }, "name": "add5xxFaultCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 39 }, "name": "add5xxFaultRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 41 }, "name": "addAverageLatencyAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring:SyntheticsCanaryMonitoringOptions" }, "cdk-monitoring-constructs.SyntheticsCanaryMonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SyntheticsCanaryMonitoringProps", "interfaces": [ "cdk-monitoring-constructs.SyntheticsCanaryMetricFactoryProps", "cdk-monitoring-constructs.SyntheticsCanaryMonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 44 }, "name": "SyntheticsCanaryMonitoringProps", "symbolId": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring:SyntheticsCanaryMonitoringProps" }, "cdk-monitoring-constructs.TaskHealthAlarmFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.TaskHealthAlarmFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 40 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 37 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 164 }, "name": "addAvailabilityAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AvailabilityThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 44 }, "name": "addHealthyTaskCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.HealthyTaskCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 82 }, "name": "addHealthyTaskPercentAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.HealthyTaskPercentThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 145 }, "name": "addMinRunningTaskCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MinRunningTaskCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 101 }, "name": "addRunningTaskCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.RunningTaskCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 120 }, "name": "addRunningTaskRateAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.RunningTaskRateThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 63 }, "name": "addUnhealthyTaskCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.UnhealthyTaskCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } } ], "name": "TaskHealthAlarmFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 38 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ], "symbolId": "lib/common/monitoring/alarms/TaskHealthAlarmFactory:TaskHealthAlarmFactory" }, "cdk-monitoring-constructs.ThrottledEventsThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ThrottledEventsThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/DynamoAlarmFactory.ts", "line": 18 }, "name": "ThrottledEventsThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/DynamoAlarmFactory.ts", "line": 19 }, "name": "maxThrottledEventsThreshold", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/DynamoAlarmFactory:ThrottledEventsThreshold" }, "cdk-monitoring-constructs.ThroughputAlarmFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ThroughputAlarmFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/ThroughputAlarmFactory.ts", "line": 19 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/ThroughputAlarmFactory.ts", "line": 16 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/ThroughputAlarmFactory.ts", "line": 23 }, "name": "addMinProcessedBytesAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MinProcessedBytesThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } } ], "name": "ThroughputAlarmFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/ThroughputAlarmFactory.ts", "line": 17 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ], "symbolId": "lib/common/monitoring/alarms/ThroughputAlarmFactory:ThroughputAlarmFactory" }, "cdk-monitoring-constructs.TopicAlarmFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.TopicAlarmFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/TopicAlarmFactory.ts", "line": 24 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/TopicAlarmFactory.ts", "line": 21 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/TopicAlarmFactory.ts", "line": 47 }, "name": "addMaxMessagesPublishedAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.HighMessagesPublishedThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/TopicAlarmFactory.ts", "line": 66 }, "name": "addMessageNotificationsFailedAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.NotificationsFailedThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/TopicAlarmFactory.ts", "line": 28 }, "name": "addMinMessagesPublishedAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.LowMessagesPublishedThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } } ], "name": "TopicAlarmFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/TopicAlarmFactory.ts", "line": 22 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ], "symbolId": "lib/common/monitoring/alarms/TopicAlarmFactory:TopicAlarmFactory" }, "cdk-monitoring-constructs.TpsAlarmFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.TpsAlarmFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/TpsAlarmFactory.ts", "line": 20 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/TpsAlarmFactory.ts", "line": 17 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/TpsAlarmFactory.ts", "line": 44 }, "name": "addMaxTpsAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.HighTpsThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/TpsAlarmFactory.ts", "line": 24 }, "name": "addMinTpsAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.LowTpsThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } } ], "name": "TpsAlarmFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/TpsAlarmFactory.ts", "line": 18 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ], "symbolId": "lib/common/monitoring/alarms/TpsAlarmFactory:TpsAlarmFactory" }, "cdk-monitoring-constructs.UnhealthyTaskCountThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.UnhealthyTaskCountThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 13 }, "name": "UnhealthyTaskCountThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/TaskHealthAlarmFactory.ts", "line": 14 }, "name": "maxUnhealthyTasks", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/TaskHealthAlarmFactory:UnhealthyTaskCountThreshold" }, "cdk-monitoring-constructs.UsageAlarmFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.UsageAlarmFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 43 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 40 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 47 }, "name": "addMaxCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MaxUsageCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 129 }, "name": "addMaxCpuUsagePercentAlarm", "parameters": [ { "name": "percentMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.UsageThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } }, { "name": "usageType", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.UsageType" } }, { "name": "additionalAlarmNameSuffix", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 232 }, "name": "addMaxDiskUsagePercentAlarm", "parameters": [ { "name": "percentMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.UsageThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 270 }, "name": "addMaxFileDescriptorPercentAlarm", "parameters": [ { "name": "percentMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.UsageThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 251 }, "name": "addMaxHeapMemoryAfterGCUsagePercentAlarm", "parameters": [ { "name": "percentMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.UsageThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 157 }, "name": "addMaxMasterCpuUsagePercentAlarm", "parameters": [ { "name": "percentMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.UsageThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 213 }, "name": "addMaxMasterMemoryUsagePercentAlarm", "parameters": [ { "name": "percentMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.UsageThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 176 }, "name": "addMaxMemoryUsagePercentAlarm", "parameters": [ { "name": "percentMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.UsageThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 308 }, "name": "addMaxReadIOPSAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MaxUsageCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 289 }, "name": "addMaxThreadCountUsageAlarm", "parameters": [ { "name": "percentMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.UsageCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "deprecated": "Use {@link addMaxCountAlarm } instead.", "stability": "deprecated" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 88 }, "name": "addMaxUsageCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.UsageCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 327 }, "name": "addMaxWriteIOPSAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MaxUsageCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 189 }, "name": "addMemoryUsagePercentAlarm", "parameters": [ { "name": "percentMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.UsageThreshold" } }, { "name": "usageType", "type": { "fqn": "cdk-monitoring-constructs.UsageType" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 66 }, "name": "addMinCountAlarm", "parameters": [ { "name": "percentMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MinUsageCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "deprecated": "Use {@link addMinCountAlarm } instead.", "stability": "deprecated" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 110 }, "name": "addMinUsageCountAlarm", "parameters": [ { "name": "percentMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MinUsageCountThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } } ], "name": "UsageAlarmFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 41 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ], "symbolId": "lib/common/monitoring/alarms/UsageAlarmFactory:UsageAlarmFactory" }, "cdk-monitoring-constructs.UsageCountThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "deprecated": "Use MaxUsageCountThreshold instead.", "stability": "deprecated" }, "fqn": "cdk-monitoring-constructs.UsageCountThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 36 }, "name": "UsageCountThreshold", "properties": [ { "abstract": true, "docs": { "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 37 }, "name": "maxUsageCount", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/UsageAlarmFactory:UsageCountThreshold" }, "cdk-monitoring-constructs.UsageThreshold": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.UsageThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 21 }, "name": "UsageThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 22 }, "name": "maxUsagePercent", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/UsageAlarmFactory:UsageThreshold" }, "cdk-monitoring-constructs.UsageType": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.UsageType", "kind": "enum", "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 9 }, "members": [ { "docs": { "stability": "experimental" }, "name": "P50" }, { "docs": { "stability": "experimental" }, "name": "P70" }, { "docs": { "stability": "experimental" }, "name": "P90" }, { "docs": { "stability": "experimental" }, "name": "P99" }, { "docs": { "stability": "experimental" }, "name": "P999" }, { "docs": { "stability": "experimental" }, "name": "P9999" }, { "docs": { "stability": "experimental" }, "name": "P100" }, { "docs": { "stability": "experimental" }, "name": "AVERAGE" }, { "docs": { "stability": "experimental" }, "name": "MAX" } ], "name": "UsageType", "symbolId": "lib/common/monitoring/alarms/UsageAlarmFactory:UsageType" }, "cdk-monitoring-constructs.UserProvidedNames": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.UserProvidedNames", "kind": "interface", "locationInModule": { "filename": "lib/dashboard/MonitoringNamingStrategy.ts", "line": 19 }, "name": "UserProvidedNames", "properties": [ { "abstract": true, "docs": { "default": "- derives name from the construct itself", "remarks": "This unique among other resources, and respect the AWS CDK restriction posed on alarm names.\nThe length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens.", "stability": "experimental", "summary": "Plain name, used in naming alarms." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/MonitoringNamingStrategy.ts", "line": 33 }, "name": "alarmFriendlyName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- use alarmFriendlyName", "remarks": "There are no limitations on what it can be.", "stability": "experimental", "summary": "Human-readable name is a freeform string, used as a caption or description." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/MonitoringNamingStrategy.ts", "line": 26 }, "name": "humanReadableName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens.", "see": "AlarmNamingStrategy for more details on alarm name prefixes", "stability": "experimental", "summary": "If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value." }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/MonitoringNamingStrategy.ts", "line": 40 }, "name": "localAlarmNamePrefixOverride", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/dashboard/MonitoringNamingStrategy:UserProvidedNames" }, "cdk-monitoring-constructs.WafV2AspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.WafV2AspectType", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringAspectType" ], "kind": "interface", "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 178 }, "name": "WafV2AspectType", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/IMonitoringAspect.ts", "line": 179 }, "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.WafV2MonitoringOptions" } } ], "symbolId": "lib/facade/IMonitoringAspect:WafV2AspectType" }, "cdk-monitoring-constructs.WafV2MetricFactory": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.BaseMetricFactory", "docs": { "stability": "experimental", "summary": "https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html." }, "fqn": "cdk-monitoring-constructs.WafV2MetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2MetricFactory.ts", "line": 25 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.WafV2MetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2MetricFactory.ts", "line": 22 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2MetricFactory.ts", "line": 39 }, "name": "metricAllowedRequests", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2MetricFactory.ts", "line": 53 }, "name": "metricBlockedRequests", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2MetricFactory.ts", "line": 67 }, "name": "metricBlockedRequestsRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } } } ], "name": "WafV2MetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2MetricFactory.ts", "line": 23 }, "name": "dimensions", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-wafv2/WafV2MetricFactory:WafV2MetricFactory" }, "cdk-monitoring-constructs.WafV2MetricFactoryProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.WafV2MetricFactoryProps", "interfaces": [ "cdk-monitoring-constructs.BaseMetricFactoryProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2MetricFactory.ts", "line": 12 }, "name": "WafV2MetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Note that the \"region\" prop is required if this has a \"REGIONAL\" scope." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2MetricFactory.ts", "line": 16 }, "name": "acl", "type": { "fqn": "aws-cdk-lib.aws_wafv2.CfnWebACL" } } ], "symbolId": "lib/monitoring/aws-wafv2/WafV2MetricFactory:WafV2MetricFactoryProps" }, "cdk-monitoring-constructs.WafV2Monitoring": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.Monitoring", "docs": { "see": "https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html", "stability": "experimental", "summary": "Monitoring for AWS Web Application Firewall." }, "fqn": "cdk-monitoring-constructs.WafV2Monitoring", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 58 }, "parameters": [ { "name": "scope", "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.WafV2MonitoringProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 45 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 142 }, "name": "createAllowedRequestsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 163 }, "name": "createBlockedRequestsRateWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 152 }, "name": "createBlockedRequestsWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 135 }, "name": "createTitleWidget", "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 111 }, "name": "summaryWidgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } }, { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 123 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.Monitoring", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IWidget" }, "kind": "array" } } } } ], "name": "WafV2Monitoring", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 48 }, "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 54 }, "name": "allowedRequestsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 55 }, "name": "blockedRequestsMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 56 }, "name": "blockedRequestsRateMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 49 }, "name": "errorAlarmFactory", "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 51 }, "name": "errorCountAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 52 }, "name": "errorRateAnnotations", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 46 }, "name": "humanReadableName", "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-wafv2/WafV2Monitoring:WafV2Monitoring" }, "cdk-monitoring-constructs.WafV2MonitoringOptions": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.WafV2MonitoringOptions", "interfaces": [ "cdk-monitoring-constructs.BaseMonitoringProps" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 31 }, "name": "WafV2MonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 32 }, "name": "addBlockedRequestsCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 33 }, "name": "addBlockedRequestsRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-wafv2/WafV2Monitoring:WafV2MonitoringOptions" }, "cdk-monitoring-constructs.WafV2MonitoringProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.WafV2MonitoringProps", "interfaces": [ "cdk-monitoring-constructs.WafV2MetricFactoryProps", "cdk-monitoring-constructs.WafV2MonitoringOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 36 }, "name": "WafV2MonitoringProps", "symbolId": "lib/monitoring/aws-wafv2/WafV2Monitoring:WafV2MonitoringProps" } }, "version": "10.2.0", "fingerprint": "uv9NyH3JRrrS2XMeseA83V6X4GkjQAJgFQ04/a2Z49c=" }