{ "author": { "email": "monitoring-cdk-constructs@amazon.com", "name": "CDK Monitoring Constructs Team", "roles": [ "author" ] }, "dependencies": { "@aws-cdk/aws-apigatewayv2-alpha": "^2.18.0-alpha.0", "@aws-cdk/aws-appsync-alpha": "^2.18.0-alpha.0", "@aws-cdk/aws-redshift-alpha": "^2.18.0-alpha.0", "@aws-cdk/aws-synthetics-alpha": "^2.18.0-alpha.0", "aws-cdk-lib": "^2.18.0", "constructs": "^10.0.5" }, "dependencyClosure": { "@aws-cdk/aws-apigatewayv2-alpha": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Apigatewayv2.Alpha", "packageId": "Amazon.CDK.AWS.APIGatewayv2.Alpha" }, "go": { "moduleName": "github.com/aws/aws-cdk-go", "packageName": "awscdkapigatewayv2alpha" }, "java": { "maven": { "artifactId": "apigatewayv2-alpha", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.apigatewayv2.alpha" }, "js": { "npm": "@aws-cdk/aws-apigatewayv2-alpha" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-apigatewayv2-alpha", "module": "aws_cdk.aws_apigatewayv2_alpha" } } }, "@aws-cdk/aws-appsync-alpha": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.AppSync.Alpha", "packageId": "Amazon.CDK.AWS.AppSync.Alpha" }, "go": { "moduleName": "github.com/aws/aws-cdk-go", "packageName": "awscdkappsyncalpha" }, "java": { "maven": { "artifactId": "appsync-alpha", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.appsync.alpha" }, "js": { "npm": "@aws-cdk/aws-appsync-alpha" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-appsync-alpha", "module": "aws_cdk.aws_appsync_alpha" } } }, "@aws-cdk/aws-redshift-alpha": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Redshift.Alpha", "packageId": "Amazon.CDK.AWS.Redshift.Alpha" }, "go": { "moduleName": "github.com/aws/aws-cdk-go", "packageName": "awscdkredshiftalpha" }, "java": { "maven": { "artifactId": "redshift-alpha", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.redshift.alpha" }, "js": { "npm": "@aws-cdk/aws-redshift-alpha" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-redshift-alpha", "module": "aws_cdk.aws_redshift_alpha" } } }, "@aws-cdk/aws-synthetics-alpha": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Synthetics.Alpha", "packageId": "Amazon.CDK.AWS.Synthetics.Alpha" }, "go": { "moduleName": "github.com/aws/aws-cdk-go", "packageName": "awscdksyntheticsalpha" }, "java": { "maven": { "artifactId": "synthetics-alpha", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.synthetics.alpha" }, "js": { "npm": "@aws-cdk/aws-synthetics-alpha" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-synthetics-alpha", "module": "aws_cdk.aws_synthetics_alpha" } } }, "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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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": { "targets": { "dotnet": { "namespace": "Amazon.CDK.CloudAssembly.Schema" }, "java": { "package": "software.amazon.awscdk.cloudassembly.schema" }, "python": { "module": "aws_cdk.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/master/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": "1.65.0 (build 7a02b7f)", "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[![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[![NPM version](https://badge.fury.io/js/cdk-monitoring-constructs.svg)](https://badge.fury.io/js/cdk-monitoring-constructs)\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[![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[![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.\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 languages (see below)\n\n\n## Installation\n\n
TypeScript\n\n> https://www.npmjs.com/package/cdk-monitoring-constructs\n\nIn your `package.json`:\n\n```json\n{\n \"dependencies\": {\n \"cdk-monitoring-constructs\": \"^1.0.0\",\n\n // peer dependencies of cdk-monitoring-constructs\n \"@aws-cdk/aws-apigatewayv2-alpha\": \"^2.18.0-alpha.0\",\n \"@aws-cdk/aws-appsync-alpha\": \"^2.18.0-alpha.0\",\n \"@aws-cdk/aws-redshift-alpha\": \"^2.18.0-alpha.0\",\n \"@aws-cdk/aws-synthetics-alpha\": \"^2.18.0-alpha.0\",\n \"aws-cdk-lib\": \"^2.18.0\",\n \"constructs\": \"^10.0.5\"\n\n // ...your other dependencies...\n }\n}\n```\n
\n\n
Java\n\nSee https://mvnrepository.com/artifact/io.github.cdklabs/cdkmonitoringconstructs\n
\n\n
Python\n\nSee https://pypi.org/project/cdk-monitoring-constructs/\n
\n\n
C#\n\nSee https://www.nuget.org/packages/Cdklabs.CdkMonitoringConstructs/\n
\n\n
Golang\n\nComing soon!\n
\n\n\n## Features\n\nSee [API](API.md) for complete auto-generated documentation.\n\nYou can also browse the documentation at https://constructs.dev/packages/cdk-monitoring-constructs/\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| AWS Billing (`.monitorBilling()`) | AWS account cost | | [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 | | |\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 RDS (`.monitorRdsCluster()`) | Query duration, connections, latency, disk/CPU usage | Disk and CPU usage | |\n| AWS Redshift (`.monitorRedshiftCluster()`) | Query duration, connections, latency, disk/CPU usage | Disk and CPU usage | |\n| AWS S3 Bucket (`.monitorS3Bucket()`) | Bucket size and number of objects | | |\n| AWS SecretsManager (`.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 (`.monitorWebApplicationFirewallAcl()`) | Allowed/blocked requests | | |\n| Custom metrics (`.monitorCustom()`) | Addition of custom metrics into the dashboard (each group is a widget) | | Supports anomaly detection |\n\n\n## Getting started\n\n### Create monitoring stack and facade\n\n_Important note_: **Please, do NOT import anything from the `/dist/lib` package.** This is unsupported and might break any time.\n\nCreate an instance of `MonitoringFacade`, which is the main entry point:\n\n```ts\nexport interface MonitoringStackProps extends DeploymentStackProps {\n // ...\n}\n\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({ /* table1 */ })\n .monitorDynamoTable({ /* table2 */ })\n .monitorDynamoTable({ /* table3 */ })\n // etc.\n }\n}\n```\n\n### Set up your monitoring\n\nOnce the facade is created, you can use it to call methods like `.monitorLambdaFunction()` and chain them together to define your monitors.\n\nYou can also use facade methods to add your own widgets, headers of various sizes, and more.\n\n\n### Customize actions\n\nAlarms should have an action setup, otherwise they are not very useful. Currently, we support notifying an SNS queue.\n\n```ts\nconst onAlarmTopic = new Topic(this, \"AlarmTopic\");\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\nmonitoring\n .monitorSomething(something, {\n addSomeAlarm: {\n Warning: {\n // ...other props\n threshold: 42,\n actionOverride: new SnsAlarmActionStrategy({ onAlarmTopic }),\n }\n }\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\n// create metrics manually\nconst m1 = new Metric(/* ... */);\n```\n\n```ts\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 metrics: [\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 metrics: [\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 metrics: [\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 }\n ]\n})\n```\n\nSearch metric does not support setting an alarm, that is a CloudWatch limitation.\n\n### Custom monitoring segment\n\nIf you want even more flexibility, you can create your own Dashboard 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 factor 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()`.\n\n### Monitoring Scopes\n\nWith CDK Monitoring Constructs, you can monitor complete CDK construct scopes. It will automatically discover all monitorable resources within the scope (recursively)) and add them to your dashboard.\n\n```ts\nmonitoring.monitorScope(stack);\n```\n\nYou can also specify default alarms for any specific resource and disable automatic monitoring for it as well.\n\n```ts\nmonitoring.monitorScope(stack, {\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, but can be explicitly disabled.\n billing: { enabled: false },\n ec2: { enabled: false },\n elasticCache: { enabled: false },\n});\n```\n\n## Contributing/Security\n\nSee [CONTRIBUTING](CONTRIBUTING.md) for more information.\n\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": 66 }, "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": 105 }, "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": 124 }, "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": 150 }, "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": 145 }, "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": 155 }, "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": 72 }, "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": 140 }, "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": 133 }, "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": 93 }, "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": 86 }, "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": 209 }, "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": 202 }, "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": 160 }, "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 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": 80 }, "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": 100 }, "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": 112 }, "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": 183 }, "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": 167 }, "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": 216 }, "name": "fillAlarmRange", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default behaviour - no condition on sample count will be added to the alarm", "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": "experimental", "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": 195 }, "name": "minMetricSamplesToAlarm", "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": 223 }, "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": 230 }, "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": 237 }, "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": 174 }, "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": 119 }, "name": "runbookLink", "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": 243 }, "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": 275 }, "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": 249 }, "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": 319 }, "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": 312 }, "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": 282 }, "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": 270 }, "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": 263 }, "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": 303 }, "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": 347 }, "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": 333 }, "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": 326 }, "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": 257 }, "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": 289 }, "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": 340 }, "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": 296 }, "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": 24 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/AgeAlarmFactory.ts", "line": 21 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/AgeAlarmFactory.ts", "line": 66 }, "name": "addDaysSinceUpdateAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 28 }, "name": "addDaysToExpiryAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 47 }, "name": "addIteratorMaxAgeAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MaxAgeThreshold" } }, { "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": 22 }, "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/IAlarmActionStrategy.ts", "line": 8 }, "name": "AlarmActionStrategyProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmActionStrategy.ts", "line": 9 }, "name": "alarm", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.AlarmBase" } } ], "symbolId": "lib/common/alarm/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": 17 }, "name": "datapointsToAlarm", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 18 }, "name": "evaluationPeriods", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 19 }, "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 16 }, "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": 20 }, "name": "overrideAnnotationColor", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 21 }, "name": "overrideAnnotationLabel", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 22 }, "name": "overrideAnnotationVisibility", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/common/alarm/IAlarmAnnotationStrategy:AlarmAnnotationStrategyProps" }, "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": 455 }, "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": 449 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 466 }, "name": "addAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 632 }, "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": 743 }, "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": 688 }, "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": 672 }, "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": 715 }, "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": 739 }, "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": 453 }, "name": "alarmNamingStrategy", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmNamingStrategy" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 450 }, "name": "alarmScope", "protected": true, "type": { "fqn": "constructs.Construct" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 451 }, "name": "globalAlarmDefaults", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactoryDefaults" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 452 }, "name": "globalMetricDefaults", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactoryDefaults" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 707 }, "name": "shouldUseDefaultDedupeForError", "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 711 }, "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": 369 }, "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": 373 }, "name": "actionsEnabled", "type": { "union": { "types": [ { "primitive": "boolean" }, { "collection": { "elementtype": { "primitive": "boolean" }, "kind": "map" } } ] } } }, { "abstract": true, "docs": { "remarks": "This should be something unique to avoid collisions with other CTIs.\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": 414 }, "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": 380 }, "name": "action", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.IAlarmActionStrategy" } }, { "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": 387 }, "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": 401 }, "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": 394 }, "name": "dedupeStringProcessor", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.IAlarmDedupeStringProcessor" } }, { "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": 419 }, "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": 408 }, "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": 424 }, "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": 432 }, "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": 440 }, "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": 443 }, "name": "AlarmFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 444 }, "name": "globalAlarmDefaults", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactoryDefaults" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 445 }, "name": "globalMetricDefaults", "type": { "fqn": "cdk-monitoring-constructs.MetricFactoryDefaults" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 446 }, "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": 40 }, "name": "AlarmMetadata", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 41 }, "name": "action", "type": { "fqn": "cdk-monitoring-constructs.IAlarmActionStrategy" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 45 }, "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": 44 }, "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": 42 }, "name": "dedupeString", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 43 }, "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/AlarmNamingStrategy.ts", "line": 9 }, "name": "AlarmNamingInput", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmNamingStrategy.ts", "line": 10 }, "name": "alarmNameSuffix", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmNamingStrategy.ts", "line": 12 }, "name": "alarmDedupeStringSuffix", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmNamingStrategy.ts", "line": 11 }, "name": "alarmNameOverride", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmNamingStrategy.ts", "line": 13 }, "name": "dedupeStringOverride", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmNamingStrategy.ts", "line": 14 }, "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/common/alarm/AlarmNamingStrategy: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": 22 }, "parameters": [ { "name": "globalPrefix", "type": { "primitive": "string" } }, { "name": "localPrefix", "type": { "primitive": "string" } }, { "name": "dedupeStringStrategy", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.IAlarmDedupeStringProcessor" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/alarm/AlarmNamingStrategy.ts", "line": 17 }, "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": 78 }, "name": "getDedupeString", "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": 40 }, "name": "getName", "parameters": [ { "docs": { "summary": "properties." }, "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmNamingInput" } } ], "returns": { "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/AlarmNamingStrategy.ts", "line": 58 }, "name": "getWidgetLabel", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmNamingInput" } } ], "returns": { "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/AlarmNamingStrategy.ts", "line": 99 }, "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": 20 }, "name": "dedupeStringStrategy", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.IAlarmDedupeStringProcessor" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmNamingStrategy.ts", "line": 18 }, "name": "globalPrefix", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmNamingStrategy.ts", "line": 19 }, "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": 51 }, "name": "AlarmWithAnnotation", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 52 }, "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": 56 }, "name": "alarmDescription", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 55 }, "name": "alarmLabel", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 53 }, "name": "alarmName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 54 }, "name": "alarmNameSuffix", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/AlarmFactory.ts", "line": 58 }, "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": 59 }, "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": 57 }, "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": 60 }, "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.ApiGatewayMetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ApiGatewayMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 48 }, "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": 42 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 98 }, "name": "metric4XXErrorCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 109 }, "name": "metric4XXErrorRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 119 }, "name": "metric5XXFaultCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 130 }, "name": "metric5XXFaultRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 87 }, "name": "metricInvocationCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 77 }, "name": "metricInvocationRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 161 }, "name": "metricLatencyInMillis", "parameters": [ { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "deprecated": "use metricLatencyInMillis instead", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 157 }, "name": "metricLatencyP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "deprecated": "use metricLatencyInMillis instead", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 150 }, "name": "metricLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "deprecated": "use metricLatencyInMillis instead", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 143 }, "name": "metricLatencyP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "deprecated": "use metricInvocationRate", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 67 }, "name": "metricTps", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "ApiGatewayMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 46 }, "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": 44 }, "name": "fillTpsWithZeroes", "protected": true, "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 43 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 45 }, "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 15 }, "name": "ApiGatewayMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "API to monitor (cannot use IRestApi, since it does not provide API name)." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts", "line": 19 }, "name": "api", "type": { "fqn": "aws-cdk-lib.aws_apigateway.RestApiBase" } }, { "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": 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-apigateway/ApiGatewayMetricFactory.ts", "line": 31 }, "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": 23 }, "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": 35 }, "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": 39 }, "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": 109 }, "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": 86 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 324 }, "name": "createErrorCountWidget", "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-apigateway/ApiGatewayMonitoring.ts", "line": 335 }, "name": "createErrorRateWidget", "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-apigateway/ApiGatewayMonitoring.ts", "line": 309 }, "name": "createLatencyWidget", "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-apigateway/ApiGatewayMonitoring.ts", "line": 291 }, "name": "createTitleWidget", "protected": true, "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 298 }, "name": "createTpsWidget", "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-apigateway/ApiGatewayMonitoring.ts", "line": 272 }, "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": 281 }, "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": 89 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 100 }, "name": "error4XXCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 101 }, "name": "error4XXRateMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 90 }, "name": "errorAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 96 }, "name": "errorCountAnnotations", "protected": true, "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": 97 }, "name": "errorRateAnnotations", "protected": true, "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": "fault5XXCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 103 }, "name": "fault5XXRateMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 92 }, "name": "latencyAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 95 }, "name": "latencyAnnotations", "protected": true, "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": 106 }, "name": "latencyMetrics", "protected": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 107 }, "name": "latencyTypesToRender", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 87 }, "name": "title", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 91 }, "name": "tpsAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.TpsAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 94 }, "name": "tpsAnnotations", "protected": true, "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": 99 }, "name": "tpsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } ], "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": 46 }, "name": "ApiGatewayMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring.ts", "line": 47 }, "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": 48 }, "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": 49 }, "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": 50 }, "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": 70 }, "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": 67 }, "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": 59 }, "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": 52 }, "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": 53 }, "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": 54 }, "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": 55 }, "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": 58 }, "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": 57 }, "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": 56 }, "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": 60 }, "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": 61 }, "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": 62 }, "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": 63 }, "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": 66 }, "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": 65 }, "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": 64 }, "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": "addLowTpsAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LowTpsThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- p50, p90, p99 (", "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).", "see": "DefaultLatencyTypesToRender)", "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": 79 }, "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": 82 }, "name": "ApiGatewayMonitoringProps", "symbolId": "lib/monitoring/aws-apigateway/ApiGatewayMonitoring:ApiGatewayMonitoringProps" }, "cdk-monitoring-constructs.ApiGatewayV2HttpApiMetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.ApiGatewayV2HttpApiMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 45 }, "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": 39 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 93 }, "name": "metric4xxCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 104 }, "name": "metric4xxRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 125 }, "name": "metric5xxRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 177 }, "name": "metricIntegrationLatencyInMillis", "parameters": [ { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "deprecated": "use metricIntegrationLatencyInMillis instead", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 159 }, "name": "metricIntegrationLatencyP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "deprecated": "use metricIntegrationLatencyInMillis instead", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 166 }, "name": "metricIntegrationLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "deprecated": "use metricIntegrationLatencyInMillis instead", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 173 }, "name": "metricIntegrationLatencyP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 82 }, "name": "metricInvocationCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 73 }, "name": "metricInvocationRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 189 }, "name": "metricLatencyInMillis", "parameters": [ { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "deprecated": "use metricLatencyInMillis instead", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 138 }, "name": "metricLatencyP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "deprecated": "use metricLatencyInMillis instead", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 145 }, "name": "metricLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "deprecated": "use metricLatencyInMillis instead", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 152 }, "name": "metricLatencyP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "deprecated": "use metricInvocationRate", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 64 }, "name": "metricTps", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "ApiGatewayV2HttpApiMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 43 }, "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": 41 }, "name": "fillTpsWithZeroes", "protected": true, "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 40 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 42 }, "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 15 }, "name": "ApiGatewayV2HttpApiMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts", "line": 16 }, "name": "api", "type": { "fqn": "@aws-cdk/aws-apigatewayv2-alpha.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": 24 }, "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": 28 }, "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": 20 }, "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": 32 }, "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": 36 }, "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": 133 }, "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": 104 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 396 }, "name": "createErrorCountWidget", "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-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 407 }, "name": "createErrorRateWidget", "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-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 376 }, "name": "createLatencyWidget", "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-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 358 }, "name": "createTitleWidget", "protected": true, "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 365 }, "name": "createTpsWidget", "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-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 339 }, "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": 348 }, "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": 107 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 119 }, "name": "error4xxCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 120 }, "name": "error4xxRateMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 122 }, "name": "error5xxCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 123 }, "name": "error5xxRateMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 108 }, "name": "errorAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 114 }, "name": "errorCountAnnotations", "protected": true, "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": 115 }, "name": "errorRateAnnotations", "protected": true, "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": 127 }, "name": "integrationLatencyMetrics", "protected": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 110 }, "name": "latencyAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 113 }, "name": "latencyAnnotations", "protected": true, "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": 126 }, "name": "latencyMetrics", "protected": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 131 }, "name": "latencyTypesToRender", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 105 }, "name": "title", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 109 }, "name": "tpsAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.TpsAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 112 }, "name": "tpsAnnotations", "protected": true, "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": 117 }, "name": "tpsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } ], "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": 100 }, "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": 47 }, "name": "ApiGatewayV2MonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 48 }, "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": 49 }, "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": 50 }, "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": 51 }, "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": 88 }, "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": 85 }, "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": 77 }, "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": 70 }, "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": 71 }, "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": 72 }, "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": 73 }, "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": 76 }, "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": 75 }, "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": 74 }, "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": 78 }, "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": 79 }, "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": 80 }, "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": 81 }, "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": 84 }, "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": 83 }, "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": 82 }, "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": 68 }, "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": 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-apigatewayv2/ApiGatewayV2HttpApiMonitoring.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-apigatewayv2/ApiGatewayV2HttpApiMonitoring.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-apigatewayv2/ApiGatewayV2HttpApiMonitoring.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-apigatewayv2/ApiGatewayV2HttpApiMonitoring.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-apigatewayv2/ApiGatewayV2HttpApiMonitoring.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-apigatewayv2/ApiGatewayV2HttpApiMonitoring.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-apigatewayv2/ApiGatewayV2HttpApiMonitoring.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-apigatewayv2/ApiGatewayV2HttpApiMonitoring.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-apigatewayv2/ApiGatewayV2HttpApiMonitoring.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-apigatewayv2/ApiGatewayV2HttpApiMonitoring.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-apigatewayv2/ApiGatewayV2HttpApiMonitoring.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-apigatewayv2/ApiGatewayV2HttpApiMonitoring.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-apigatewayv2/ApiGatewayV2HttpApiMonitoring.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-apigatewayv2/ApiGatewayV2HttpApiMonitoring.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-apigatewayv2/ApiGatewayV2HttpApiMonitoring.ts", "line": 87 }, "name": "addLowTpsAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LowTpsThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- p50, p90, p99 (", "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).", "see": "DefaultLatencyTypesShown)", "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": 97 }, "name": "latencyTypesToRender", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LatencyType" }, "kind": "array" } } } ], "symbolId": "lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMonitoring:ApiGatewayV2MonitoringOptions" }, "cdk-monitoring-constructs.AppSyncMetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AppSyncMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 35 }, "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": 29 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 112 }, "name": "metric4XXErrorCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 123 }, "name": "metric4XXErrorRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 133 }, "name": "metric5XXFaultCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 144 }, "name": "metric5XXFaultRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 79 }, "name": "metricLatencyP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 90 }, "name": "metricLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 101 }, "name": "metricLatencyP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 68 }, "name": "metricRequestCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 58 }, "name": "metricRequestRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "deprecated": "use metricRequestRate", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 48 }, "name": "metricTps", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "AppSyncMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 33 }, "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": 31 }, "name": "fillTpsWithZeroes", "protected": true, "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 30 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 32 }, "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMetricFactory.ts", "line": 12 }, "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": 16 }, "name": "api", "type": { "fqn": "@aws-cdk/aws-appsync-alpha.GraphqlApi" } }, { "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": 21 }, "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": 26 }, "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": 82 }, "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": 58 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 273 }, "name": "createErrorCountWidget", "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-appsync/AppSyncMonitoring.ts", "line": 284 }, "name": "createErrorRateWidget", "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-appsync/AppSyncMonitoring.ts", "line": 258 }, "name": "createLatencyWidget", "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-appsync/AppSyncMonitoring.ts", "line": 247 }, "name": "createTpsWidget", "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-appsync/AppSyncMonitoring.ts", "line": 240 }, "name": "createtTitleWidget", "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-appsync/AppSyncMonitoring.ts", "line": 221 }, "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": 230 }, "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": 63 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 79 }, "name": "error4xxCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 80 }, "name": "error4xxRateMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 64 }, "name": "errorAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 70 }, "name": "errorCountAnnotations", "protected": true, "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": 71 }, "name": "errorRateAnnotations", "protected": true, "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": 77 }, "name": "fault5xxCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 78 }, "name": "fault5xxRateMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 65 }, "name": "latencyAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 69 }, "name": "latencyAnnotations", "protected": true, "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": 62 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AppSyncMetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 61 }, "name": "namingStrategy", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringNamingStrategy" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 74 }, "name": "p50LatencyMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 75 }, "name": "p90LatencyMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 76 }, "name": "p99LatencyMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 59 }, "name": "title", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 66 }, "name": "tpsAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.TpsAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 68 }, "name": "tpsAnnotations", "protected": true, "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": 73 }, "name": "tpsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } ], "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": 40 }, "name": "AppSyncMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-appsync/AppSyncMonitoring.ts", "line": 41 }, "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": 42 }, "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": 43 }, "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": 44 }, "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": 51 }, "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": 46 }, "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": 47 }, "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": 48 }, "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": 50 }, "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": 54 }, "name": "AppSyncMonitoringProps", "symbolId": "lib/monitoring/aws-appsync/AppSyncMonitoring:AppSyncMonitoringProps" }, "cdk-monitoring-constructs.ApplicationLoadBalancerMetricFactory": { "assembly": "cdk-monitoring-constructs", "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": 32 }, "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": 25 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 71 }, "name": "metricActiveConnectionCount", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 41 }, "name": "metricHealthyTaskCount", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 61 }, "name": "metricHealthyTaskInPercent", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 79 }, "name": "metricNewConnectionCount", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 87 }, "name": "metricProcessedBytesMin", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 51 }, "name": "metricUnhealthyTaskCount", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "ApplicationLoadBalancerMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 29 }, "name": "applicationLoadBalancer", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 30 }, "name": "applicationTargetGroup", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 28 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } } ], "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 17 }, "name": "ApplicationLoadBalancerMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 18 }, "name": "applicationLoadBalancer", "type": { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory.ts", "line": 19 }, "name": "applicationTargetGroup", "type": { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup" } } ], "symbolId": "lib/monitoring/aws-loadbalancing/ApplicationLoadBalancerMetricFactory:ApplicationLoadBalancerMetricFactoryProps" }, "cdk-monitoring-constructs.AutoScalingGroupMetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.AutoScalingGroupMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMetricFactory.ts", "line": 16 }, "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": 12 }, "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": 43 }, "name": "metricGroupDesiredCapacity", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "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": 56 }, "name": "metricGroupInServiceInstances", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental", "summary": "The maximum size of the Auto Scaling group." }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMetricFactory.ts", "line": 36 }, "name": "metricGroupMaxSize", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental", "summary": "The minimum size of the Auto Scaling group." }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMetricFactory.ts", "line": 29 }, "name": "metricGroupMinSize", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "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": 68 }, "name": "metricGroupPendingInstances", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "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": 80 }, "name": "metricGroupStandbyInstances", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "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": 92 }, "name": "metricGroupTerminatingInstances", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "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": 104 }, "name": "metricGroupTotalInstances", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "AutoScalingGroupMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMetricFactory.ts", "line": 14 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMetricFactory.ts", "line": 13 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } } ], "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMetricFactory.ts", "line": 8 }, "name": "AutoScalingGroupMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMetricFactory.ts", "line": 9 }, "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" } } ], "protected": true, "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" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 84 }, "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-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", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 34 }, "name": "groupMaxSizeMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 33 }, "name": "groupMinSizeMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 36 }, "name": "instancesInServiceMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 37 }, "name": "instancesPendingMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 38 }, "name": "instancesStandbyMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 39 }, "name": "instancesTerminatingMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 40 }, "name": "instancesTotalMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/AutoScalingGroupMonitoring.ts", "line": 31 }, "name": "title", "protected": true, "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": 100 }, "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": 124 }, "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": 34 }, "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": 40 }, "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": 146 }, "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": 64 }, "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": 129 }, "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": 88 }, "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": 76 }, "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": 82 }, "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": 58 }, "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": 118 }, "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": 106 }, "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": 112 }, "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": 158 }, "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": 94 }, "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": 46 }, "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": 52 }, "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": 70 }, "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": 38 }, "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": 55 }, "name": "BaseEc2ServiceAlarms", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 68 }, "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-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 69 }, "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": 67 }, "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": 63 }, "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": 59 }, "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": 55 }, "name": "BaseFargateServiceAlarms", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 68 }, "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-ecs-patterns/FargateServiceMonitoring.ts", "line": 69 }, "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": 67 }, "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": 63 }, "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": 59 }, "name": "minAutoScalingTaskCount", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring:BaseFargateServiceAlarms" }, "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.UserProvidedNames", "cdk-monitoring-constructs.MonitoringDashboardsOverrideProps" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/Monitoring.ts", "line": 97 }, "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": 103 }, "name": "useCreatedAlarms", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.IAlarmConsumer" } } ], "symbolId": "lib/common/monitoring/Monitoring:BaseMonitoringProps" }, "cdk-monitoring-constructs.BaseServiceMetricFactory": { "assembly": "cdk-monitoring-constructs", "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": 21 }, "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": 17 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/BaseServiceMetricFactory.ts", "line": 29 }, "name": "metricClusterCpuUtilisationInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/BaseServiceMetricFactory.ts", "line": 37 }, "name": "metricClusterMemoryUtilisationInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/BaseServiceMetricFactory.ts", "line": 45 }, "name": "metricRunningTaskCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "BaseServiceMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/BaseServiceMetricFactory.ts", "line": 18 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/BaseServiceMetricFactory.ts", "line": 19 }, "name": "service", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_ecs.BaseService" } } ], "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/BaseServiceMetricFactory.ts", "line": 10 }, "name": "BaseServiceMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/BaseServiceMetricFactory.ts", "line": 11 }, "name": "service", "type": { "fqn": "aws-cdk-lib.aws_ecs.BaseService" } } ], "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.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": 36 }, "name": "metricTotalCostInUsd", "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" } } } ], "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": 40 }, "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": 34 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-billing/BillingMonitoring.ts", "line": 80 }, "name": "createChargesByServiceWidget", "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-billing/BillingMonitoring.ts", "line": 73 }, "name": "createTitleWidget", "protected": true, "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-billing/BillingMonitoring.ts", "line": 93 }, "name": "createTotalChargesWidget", "parameters": [ { "name": "width", "type": { "primitive": "number" } }, { "name": "height", "type": { "primitive": "number" } } ], "protected": true, "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": 55 }, "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": 62 }, "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": 37 }, "name": "costByServiceMetric", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-billing/BillingMonitoring.ts", "line": 38 }, "name": "totalCostMetric", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" } } ], "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": 31 }, "name": "BillingMonitoringOptions", "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": 32 }, "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": 25 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/dashboard/widget/BitmapWidget.ts", "line": 22 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/widget/BitmapWidget.ts", "line": 60 }, "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": 79 }, "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": 23 }, "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.CertificateManagerMetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CertificateManagerMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMetricFactory.ts", "line": 20 }, "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": 16 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMetricFactory.ts", "line": 30 }, "name": "metricDaysToExpiry", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "CertificateManagerMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMetricFactory.ts", "line": 18 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMetricFactory.ts", "line": 17 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } } ], "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMetricFactory.ts", "line": 12 }, "name": "CertificateManagerMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMetricFactory.ts", "line": 13 }, "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" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMonitoring.ts", "line": 87 }, "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-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", "protected": true, "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", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-acm/CertificateManagerMonitoring.ts", "line": 37 }, "name": "title", "protected": true, "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.CloudFrontDistributionMetricFactory": { "assembly": "cdk-monitoring-constructs", "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": 48 }, "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": 42 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 142 }, "name": "metric4xxErrorRateAverage", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 155 }, "name": "metric5xxErrorRateAverage", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 62 }, "name": "metricRequestCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 75 }, "name": "metricRequestRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "deprecated": "use metricRequestRate", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 88 }, "name": "metricRequestTps", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 111 }, "name": "metricTotalBytesDownloaded", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 98 }, "name": "metricTotalBytesUploaded", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 168 }, "name": "metricTotalErrorRateAverage", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 14 }, "name": "CloudFrontDistributionMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts", "line": 15 }, "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": 35 }, "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": 20 }, "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": 25 }, "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": 71 }, "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": 50 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 208 }, "name": "createCacheWidget", "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-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 229 }, "name": "createErrorRateWidget", "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-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 189 }, "name": "createTitleWidget", "protected": true, "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 197 }, "name": "createTpsWidget", "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-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 219 }, "name": "createTrafficWidget", "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-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 162 }, "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": 170 }, "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": 68 }, "name": "additionalMetricsEnabled", "protected": true, "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 55 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 63 }, "name": "downloadedBytesMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 65 }, "name": "error4xxRate", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 66 }, "name": "error5xxRate", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 56 }, "name": "errorAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 59 }, "name": "errorRateAnnotations", "protected": true, "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": 54 }, "name": "namingStrategy", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringNamingStrategy" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 57 }, "name": "tpsAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.TpsAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 60 }, "name": "tpsAnnotations", "protected": true, "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": 62 }, "name": "tpsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 64 }, "name": "uploadedBytesMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 69 }, "name": "cacheHitRate", "optional": true, "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } ], "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": 37 }, "name": "CloudFrontDistributionMonitoringOptions", "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": 40 }, "name": "CloudFrontDistributionMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring.ts", "line": 43 }, "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": 44 }, "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": 47 }, "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": 46 }, "name": "addLowTpsAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.LowTpsThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-cloudfront/CloudFrontDistributionMonitoring:CloudFrontDistributionMonitoringProps" }, "cdk-monitoring-constructs.CodeBuildProjectMetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.CodeBuildProjectMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 15 }, "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": 10 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 26 }, "name": "metricBuildCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 62 }, "name": "metricDurationP50InSeconds", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 53 }, "name": "metricDurationP90InSeconds", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 44 }, "name": "metricDurationP99InSeconds", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 34 }, "name": "metricFailedBuildCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 38 }, "name": "metricFailedBuildRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 30 }, "name": "metricSucceededBuildCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "CodeBuildProjectMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 12 }, "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": 11 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 13 }, "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 6 }, "name": "CodeBuildProjectMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMetricFactory.ts", "line": 7 }, "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", "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 213 }, "name": "createDurationWidget", "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 228 }, "name": "createFailedBuildRateWidget", "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 190 }, "name": "createTitleWidget", "protected": true, "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", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 56 }, "name": "durationAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 57 }, "name": "durationAnnotations", "protected": true, "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", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 66 }, "name": "durationP90InSecondsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 65 }, "name": "durationP99InSecondsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 55 }, "name": "errorAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 58 }, "name": "errorCountAnnotations", "protected": true, "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", "protected": true, "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", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 64 }, "name": "failedBuildRateMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 62 }, "name": "succeededBuildCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 52 }, "name": "title", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-codebuild/CodeBuildProjectMonitoring.ts", "line": 53 }, "name": "projectUrl", "optional": true, "protected": 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": 357 }, "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.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.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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 12 }, "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": 18 }, "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": 84 }, "name": "actionsEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "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 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/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": 61 }, "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": 54 }, "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": 47 }, "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": 91 }, "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 realms (EU, NA...) manually.\nDedupe strings are global and not unique per CTI.", "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": 112 }, "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": 77 }, "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": 98 }, "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": 126 }, "name": "fillAlarmRange", "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": 105 }, "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": 119 }, "name": "runbookLink", "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": 68 }, "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": 135 }, "name": "CustomEc2ServiceMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 137 }, "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": 92 }, "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": 97 }, "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": 101 }, "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": 93 }, "name": "addUnhealthyTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UnhealthyTaskCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 138 }, "name": "loadBalancer", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer" }, { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.NetworkLoadBalancer" } ] } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 139 }, "name": "targetGroup", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup" }, { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.NetworkTargetGroup" } ] } } } ], "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.BaseMonitoringProps", "cdk-monitoring-constructs.BaseFargateServiceAlarms" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 135 }, "name": "CustomFargateServiceMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 137 }, "name": "fargateService", "type": { "fqn": "aws-cdk-lib.aws_ecs.FargateService" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 92 }, "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": 97 }, "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": 101 }, "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": 93 }, "name": "addUnhealthyTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UnhealthyTaskCountThreshold" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 138 }, "name": "loadBalancer", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer" }, { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.NetworkLoadBalancer" } ] } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 139 }, "name": "targetGroup", "optional": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup" }, { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.NetworkTargetGroup" } ] } } } ], "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": 147 }, "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": 180 }, "name": "metrics", "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" }, { "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": 151 }, "name": "title", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "undefined", "stability": "experimental", "summary": "optional axis." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 161 }, "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": 171 }, "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": 166 }, "name": "graphWidgetRightAxis", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.YAxisProps" } }, { "abstract": true, "docs": { "default": "line", "stability": "experimental", "summary": "type of the widget." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 156 }, "name": "graphWidgetType", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.GraphWidgetType" } }, { "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": 185 }, "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": 190 }, "name": "horizontalRightAnnotations", "optional": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "false", "stability": "experimental", "summary": "Flag indicating, whether this is an important metric group that should be included in the summary as well." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 176 }, "name": "important", "optional": true, "type": { "primitive": "boolean" } } ], "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": 199 }, "name": "CustomMetricGroupWithAnnotations", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 201 }, "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": 200 }, "name": "metricGroup", "type": { "fqn": "cdk-monitoring-constructs.CustomMetricGroup" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 202 }, "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": 203 }, "name": "titleAddons", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "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": 96 }, "name": "CustomMetricSearch", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "search dimensions (can be empty)." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 114 }, "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": 105 }, "name": "searchQuery", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "metric statistic." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 118 }, "name": "statistic", "type": { "fqn": "cdk-monitoring-constructs.MetricStatistic" } }, { "abstract": true, "docs": { "default": "- \" \"", "stability": "experimental", "summary": "custom label for the metrics." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 110 }, "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": 101 }, "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": 123 }, "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": 128 }, "name": "position", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.AxisPosition" } } ], "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": 46 }, "name": "CustomMetricWithAlarm", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "alarm definitions." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 58 }, "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": 54 }, "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": 50 }, "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 63 }, "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": 69 }, "name": "CustomMetricWithAnomalyDetection", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "alarm friendly name." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 82 }, "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": 86 }, "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": 73 }, "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "adds alarm on a detected anomaly." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 90 }, "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": 78 }, "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": 221 }, "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": 213 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 277 }, "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": 281 }, "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": 218 }, "name": "anomalyDetectingAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AnomalyDetectingAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 217 }, "name": "customAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.CustomAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 219 }, "name": "metricGroups", "protected": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.CustomMetricGroupWithAnnotations" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 214 }, "name": "title", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 215 }, "name": "description", "optional": true, "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 216 }, "name": "descriptionWidgetHeight", "optional": true, "protected": 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": 193 }, "name": "CustomMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 196 }, "name": "metricGroups", "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.CustomMetricGroup" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 194 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/custom/CustomMonitoring.ts", "line": 195 }, "name": "descriptionWidgetHeight", "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 the widgets." }, "fqn": "cdk-monitoring-constructs.DashboardRenderingPreference", "kind": "enum", "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 16 }, "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/DefaultDashboardFactory: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": 17 }, "name": "DaysSinceUpdateThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/AgeAlarmFactory.ts", "line": 18 }, "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": 87 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 88 }, "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": 96 }, "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" ], "kind": "class", "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 87 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 174 }, "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": 200 }, "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": 159 }, "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": 192 }, "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": 196 }, "name": "createdSummaryDashboard", "overrides": "cdk-monitoring-constructs.IDashboardFactory", "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": 94 }, "name": "anyDashboardCreated", "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 93 }, "name": "alarmDashboard", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 91 }, "name": "dashboard", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/DefaultDashboardFactory.ts", "line": 92 }, "name": "summaryDashboard", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" } } ], "symbolId": "lib/dashboard/DefaultDashboardFactory:DefaultDashboardFactory" }, "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.DocumentDbMetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DocumentDbMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 26 }, "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": 21 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 35 }, "name": "metricAverageCpuUsageInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 39 }, "name": "metricMaxConnectionCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 47 }, "name": "metricMaxCursorCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 51 }, "name": "metricMaxTransactionOpenCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 59 }, "name": "metricOperationsThrottledDueLowMemoryCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 67 }, "name": "metricReadLatencyInMillis", "parameters": [ { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 76 }, "name": "metricWriteLatencyInMillis", "parameters": [ { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "DocumentDbMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 22 }, "name": "clusterIdentifier", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 24 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 23 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } } ], "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 14 }, "name": "DocumentDbMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "database cluster." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMetricFactory.ts", "line": 18 }, "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" } } ], "protected": true, "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" } } ], "protected": true, "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" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 123 }, "name": "createTitleWidget", "protected": true, "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" } } ], "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-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", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 46 }, "name": "cpuUsageMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 50 }, "name": "cursorsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 47 }, "name": "readLatencyMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 52 }, "name": "throttledMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 40 }, "name": "title", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 51 }, "name": "transactionsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 43 }, "name": "usageAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.UsageAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 44 }, "name": "usageAnnotations", "protected": true, "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", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-docdb/DocumentDbMonitoring.ts", "line": 41 }, "name": "url", "optional": true, "protected": 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": 70 }, "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.DoubleAxisGraphWidgetProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 69 }, "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": 52 }, "name": "DoubleAxisGraphWidgetProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 55 }, "name": "height", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 57 }, "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": 56 }, "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": 60 }, "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": 59 }, "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": 54 }, "name": "width", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 58 }, "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": 61 }, "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": 53 }, "name": "title", "optional": true, "type": { "primitive": "string" } } ], "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": 116 }, "name": "DurationThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/LatencyAlarmFactory.ts", "line": 117 }, "name": "maxDuration", "type": { "fqn": "aws-cdk-lib.Duration" } } ], "symbolId": "lib/common/monitoring/alarms/LatencyAlarmFactory:DurationThreshold" }, "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.DynamoTableGlobalSecondaryIndexMetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DynamoTableGlobalSecondaryIndexMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 17 }, "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": 13 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 50 }, "name": "metricConsumedReadCapacityUnits", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 61 }, "name": "metricConsumedWriteCapacityUnits", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 72 }, "name": "metricIndexConsumedWriteUnitsMetric", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 28 }, "name": "metricProvisionedReadCapacityUnits", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 39 }, "name": "metricProvisionedWriteCapacityUnits", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 117 }, "name": "metricThrottledIndexRequestCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 83 }, "name": "metricThrottledReadRequestCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 100 }, "name": "metricThrottledWriteRequestCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "DynamoTableGlobalSecondaryIndexMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 15 }, "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": 14 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } } ], "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 8 }, "name": "DynamoTableGlobalSecondaryIndexMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 10 }, "name": "globalSecondaryIndexName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMetricFactory.ts", "line": 9 }, "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": 41 }, "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": 28 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 105 }, "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": 129 }, "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": 97 }, "name": "createTitleWidget", "protected": true, "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 115 }, "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": 79 }, "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": 88 }, "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": 34 }, "name": "consumedReadUnitsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 35 }, "name": "consumedWriteUnitsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 36 }, "name": "indexConsumedWriteUnitsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 39 }, "name": "indexThrottleCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 32 }, "name": "provisionedReadUnitsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 33 }, "name": "provisionedWriteUnitsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 37 }, "name": "readThrottleCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 29 }, "name": "title", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 38 }, "name": "writeThrottleCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring.ts", "line": 30 }, "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": 22 }, "name": "DynamoTableGlobalSecondaryIndexMonitoringProps", "symbolId": "lib/monitoring/aws-dynamo/DynamoTableGlobalSecondaryIndexMonitoring:DynamoTableGlobalSecondaryIndexMonitoringProps" }, "cdk-monitoring-constructs.DynamoTableMetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.DynamoTableMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 32 }, "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": 28 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 117 }, "name": "metricAverageSuccessfulRequestLatencyInMillis", "parameters": [ { "name": "operation", "type": { "fqn": "aws-cdk-lib.aws_dynamodb.Operation" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 58 }, "name": "metricConsumedReadCapacityUnits", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 70 }, "name": "metricConsumedWriteCapacityUnits", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 40 }, "name": "metricProvisionedReadCapacityUnits", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 49 }, "name": "metricProvisionedWriteCapacityUnits", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 82 }, "name": "metricReadCapacityUtilizationPercentage", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 104 }, "name": "metricSearchAverageSuccessfulRequestLatencyInMillis", "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" } } }, { "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": 167 }, "name": "metricSystemErrorsCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 130 }, "name": "metricThrottledReadRequestCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 145 }, "name": "metricThrottledWriteRequestCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 93 }, "name": "metricWriteCapacityUtilizationPercentage", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "DynamoTableMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 29 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 30 }, "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 15 }, "name": "DynamoTableMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "table to monitor." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMetricFactory.ts", "line": 19 }, "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": 25 }, "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": 146 }, "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": 114 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 418 }, "name": "createErrorsWidget", "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/DynamoTableMonitoring.ts", "line": 395 }, "name": "createLatencyWidget", "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/DynamoTableMonitoring.ts", "line": 429 }, "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/DynamoTableMonitoring.ts", "line": 407 }, "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/DynamoTableMonitoring.ts", "line": 479 }, "name": "createTitleWidget", "protected": true, "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 454 }, "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" }, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 335 }, "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": 353 }, "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": 364 }, "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": 119 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 139 }, "name": "averagePerOperationLatencyMetrics", "protected": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 132 }, "name": "consumedReadUnitsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 133 }, "name": "consumedWriteUnitsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 122 }, "name": "dynamoCapacityAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.DynamoAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 126 }, "name": "dynamoReadCapacityAnnotations", "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/DynamoTableMonitoring.ts", "line": 127 }, "name": "dynamoWriteCapacityAnnotations", "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/DynamoTableMonitoring.ts", "line": 120 }, "name": "errorAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 125 }, "name": "errorCountAnnotations", "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/DynamoTableMonitoring.ts", "line": 121 }, "name": "latencyAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 124 }, "name": "latencyAnnotations", "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/DynamoTableMonitoring.ts", "line": 137 }, "name": "latencyAverageSearchMetrics", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 130 }, "name": "provisionedReadUnitsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 131 }, "name": "provisionedWriteUnitsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 143 }, "name": "readCapacityUsageMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 134 }, "name": "readThrottleCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 136 }, "name": "systemErrorMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 117 }, "name": "tableBillingMode", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_dynamodb.BillingMode" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 128 }, "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/DynamoTableMonitoring.ts", "line": 115 }, "name": "title", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 144 }, "name": "writeCapacityUsageMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 135 }, "name": "writeThrottleCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 116 }, "name": "tableUrl", "optional": true, "protected": 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": 51 }, "name": "DynamoTableMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-dynamo/DynamoTableMonitoring.ts", "line": 100 }, "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": 104 }, "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": 96 }, "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": 88 }, "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": 72 }, "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": 84 }, "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": 76 }, "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": 80 }, "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": 92 }, "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": 52 }, "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": 56 }, "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": 61 }, "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": 70 }, "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": 65 }, "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": 110 }, "name": "DynamoTableMonitoringProps", "symbolId": "lib/monitoring/aws-dynamo/DynamoTableMonitoring:DynamoTableMonitoringProps" }, "cdk-monitoring-constructs.EC2MetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.EC2MetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2MetricFactory.ts", "line": 143 }, "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": 139 }, "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": 154 }, "name": "metricAverageCpuUtilisationPercent", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" }, "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": 163 }, "name": "metricAverageDiskReadBytes", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" }, "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": 179 }, "name": "metricAverageDiskReadOps", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" }, "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": 172 }, "name": "metricAverageDiskWriteBytes", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" }, "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": 186 }, "name": "metricAverageDiskWriteOps", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" }, "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": 194 }, "name": "metricAverageNetworkInRateBytes", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" }, "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": 202 }, "name": "metricAverageNetworkOutRateBytes", "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" }, "kind": "array" } } } } ], "name": "EC2MetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2MetricFactory.ts", "line": 140 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2MetricFactory.ts", "line": 141 }, "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2MetricFactory.ts", "line": 126 }, "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": 131 }, "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": 136 }, "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": 39 }, "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": 27 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 101 }, "name": "createCpuWidget", "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-ec2/EC2Monitoring.ts", "line": 121 }, "name": "createDiskOpsWidget", "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-ec2/EC2Monitoring.ts", "line": 111 }, "name": "createDiskWidget", "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-ec2/EC2Monitoring.ts", "line": 131 }, "name": "createNetworkWidget", "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-ec2/EC2Monitoring.ts", "line": 94 }, "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-ec2/EC2Monitoring.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/aws-ec2/EC2Monitoring.ts", "line": 79 }, "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": 31 }, "name": "cpuUtilisationMetrics", "protected": true, "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": 32 }, "name": "diskReadBytesMetrics", "protected": true, "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": 34 }, "name": "diskReadOpsMetrics", "protected": true, "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": 33 }, "name": "diskWriteBytesMetrics", "protected": true, "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": 35 }, "name": "diskWriteOpsMetrics", "protected": true, "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": 28 }, "name": "family", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2Monitoring.ts", "line": 36 }, "name": "networkInMetrics", "protected": true, "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": 37 }, "name": "networkOutMetrics", "protected": true, "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": 29 }, "name": "title", "protected": true, "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": 21 }, "name": "EC2MonitoringOptions", "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": 25 }, "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": 129 }, "name": "Ec2ApplicationLoadBalancerMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 132 }, "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": 92 }, "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": 97 }, "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": 101 }, "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": 93 }, "name": "addUnhealthyTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UnhealthyTaskCountThreshold" }, "kind": "map" } } } ], "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": 120 }, "name": "Ec2NetworkLoadBalancerMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 123 }, "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": 92 }, "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": 97 }, "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": 101 }, "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": 93 }, "name": "addUnhealthyTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UnhealthyTaskCountThreshold" }, "kind": "map" } } } ], "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": 169 }, "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": 142 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 368 }, "name": "createCpuWidget", "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-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 379 }, "name": "createMemoryWidget", "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-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 390 }, "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-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 361 }, "name": "createTitleWidget", "protected": true, "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 411 }, "name": "createTpcFlowsWidget", "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-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 327 }, "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": 336 }, "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": 146 }, "name": "baseServiceMetricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.BaseServiceMetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 153 }, "name": "cpuUsageAnnotations", "protected": true, "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": 161 }, "name": "cpuUtilisationMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 154 }, "name": "memoryUsageAnnotations", "protected": true, "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": 162 }, "name": "memoryUtilisationMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 145 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 155 }, "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-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 160 }, "name": "runningTaskCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 149 }, "name": "taskHealthAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.TaskHealthAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 151 }, "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-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 150 }, "name": "throughputAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.ThroughputAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 143 }, "name": "title", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 152 }, "name": "usageAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.UsageAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 163 }, "name": "activeTcpFlowCountMetric", "optional": true, "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 157 }, "name": "healthyTaskCountMetric", "optional": true, "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 159 }, "name": "healthyTaskPercentMetric", "optional": true, "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 147 }, "name": "loadBalancerMetricFactory", "optional": true, "protected": true, "type": { "fqn": "cdk-monitoring-constructs.ILoadBalancerMetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 164 }, "name": "newTcpFlowCountMetric", "optional": true, "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 165 }, "name": "processedBytesMetric", "optional": true, "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 158 }, "name": "unhealthyTaskCountMetric", "optional": true, "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } ], "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": 110 }, "name": "Ec2ServiceMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 112 }, "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": 92 }, "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": 97 }, "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": 101 }, "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": 93 }, "name": "addUnhealthyTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UnhealthyTaskCountThreshold" }, "kind": "map" } } } ], "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": 24 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory.ts", "line": 21 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory.ts", "line": 47 }, "name": "addMaxEvictedItemsCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 28 }, "name": "addMaxItemsCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 85 }, "name": "addMaxUsedSwapMemoryAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 66 }, "name": "addMinFreeableMemoryAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MinFreeableMemoryThreshold" } }, { "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": 22 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ], "symbolId": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory:ElastiCacheAlarmFactory" }, "cdk-monitoring-constructs.ElastiCacheClusterMetricFactory": { "assembly": "cdk-monitoring-constructs", "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": 27 }, "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": 23 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 82 }, "name": "metricAverageCachedItemsSizeInBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 115 }, "name": "metricAverageConnections", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 60 }, "name": "metricAverageFreeableMemoryInBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 93 }, "name": "metricAverageSwapUsageInBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 71 }, "name": "metricAverageUnusedMemoryInBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 49 }, "name": "metricEvictions", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 104 }, "name": "metricMaxCpuUtilizationInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 38 }, "name": "metricMaxItemCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 126 }, "name": "metricNetworkBytesIn", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 137 }, "name": "metricNetworkBytesOut", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "ElastiCacheClusterMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 25 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 24 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } } ], "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory.ts", "line": 12 }, "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": 17 }, "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": 101 }, "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": 81 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 274 }, "name": "createConnectionsWidget", "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-elasticache/ElastiCacheClusterMonitoring.ts", "line": 234 }, "name": "createCpuUsageWidget", "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-elasticache/ElastiCacheClusterMonitoring.ts", "line": 260 }, "name": "createItemCountWidget", "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-elasticache/ElastiCacheClusterMonitoring.ts", "line": 245 }, "name": "createMemoryUsageWidget", "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-elasticache/ElastiCacheClusterMonitoring.ts", "line": 226 }, "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-elasticache/ElastiCacheClusterMonitoring.ts", "line": 207 }, "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": 216 }, "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": 85 }, "name": "connectionsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 96 }, "name": "cpuUsageAnnotations", "protected": true, "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": 86 }, "name": "cpuUsageMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 95 }, "name": "elastiCacheAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.ElastiCacheAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 98 }, "name": "evictedItemsCountAnnotations", "protected": true, "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": 87 }, "name": "freeableMemoryMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 97 }, "name": "itemsCountAnnotations", "protected": true, "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": 91 }, "name": "itemsCountMetrics", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 92 }, "name": "itemsEvictedMetrics", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 90 }, "name": "itemsMemoryMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 99 }, "name": "memoryUsageAnnotations", "protected": true, "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": 89 }, "name": "swapMemoryMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 82 }, "name": "title", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 88 }, "name": "unusedMemoryMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 94 }, "name": "usageAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.UsageAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 83 }, "name": "clusterUrl", "optional": true, "protected": 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": 37 }, "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": 42 }, "name": "clusterType", "type": { "fqn": "cdk-monitoring-constructs.ElastiCacheClusterType" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Add CPU usage alarm." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-elasticache/ElastiCacheClusterMonitoring.ts", "line": 47 }, "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": 56 }, "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": 52 }, "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": 71 }, "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": 64 }, "name": "addMinFreeableMemoryAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.MinFreeableMemoryThreshold" }, "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": 77 }, "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": 7 }, "members": [ { "docs": { "stability": "experimental" }, "name": "MEMCACHED" }, { "docs": { "stability": "experimental" }, "name": "REDIS" } ], "name": "ElastiCacheClusterType", "symbolId": "lib/monitoring/aws-elasticache/ElastiCacheClusterMetricFactory:ElastiCacheClusterType" }, "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": 35 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/ErrorAlarmFactory.ts", "line": 32 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/ErrorAlarmFactory.ts", "line": 39 }, "name": "addErrorCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "name": "errorType", "type": { "fqn": "cdk-monitoring-constructs.ErrorType" } }, { "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": 65 }, "name": "addErrorRateAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "name": "errorType", "type": { "fqn": "cdk-monitoring-constructs.ErrorType" } }, { "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": 33 }, "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": 24 }, "name": "ErrorCountThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/ErrorAlarmFactory.ts", "line": 25 }, "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": 28 }, "name": "ErrorRateThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/ErrorAlarmFactory.ts", "line": 29 }, "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" } ], "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.BaseMonitoringProps", "cdk-monitoring-constructs.BaseFargateServiceAlarms" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 129 }, "name": "FargateApplicationLoadBalancerMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 132 }, "name": "fargateService", "type": { "fqn": "aws-cdk-lib.aws_ecs.FargateService" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 92 }, "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": 97 }, "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": 101 }, "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": 93 }, "name": "addUnhealthyTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UnhealthyTaskCountThreshold" }, "kind": "map" } } } ], "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.BaseMonitoringProps", "cdk-monitoring-constructs.BaseFargateServiceAlarms" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 120 }, "name": "FargateNetworkLoadBalancerMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 123 }, "name": "fargateService", "type": { "fqn": "aws-cdk-lib.aws_ecs.FargateService" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 92 }, "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": 97 }, "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": 101 }, "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": 93 }, "name": "addUnhealthyTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UnhealthyTaskCountThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring:FargateNetworkLoadBalancerMonitoringProps" }, "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": 169 }, "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": 142 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 371 }, "name": "createCpuWidget", "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-ecs-patterns/FargateServiceMonitoring.ts", "line": 382 }, "name": "createMemoryWidget", "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-ecs-patterns/FargateServiceMonitoring.ts", "line": 393 }, "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-ecs-patterns/FargateServiceMonitoring.ts", "line": 364 }, "name": "createTitleWidget", "protected": true, "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 414 }, "name": "createTpcFlowsWidget", "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-ecs-patterns/FargateServiceMonitoring.ts", "line": 330 }, "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": 339 }, "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": 146 }, "name": "baseServiceMetricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.BaseServiceMetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 153 }, "name": "cpuUsageAnnotations", "protected": true, "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": 161 }, "name": "cpuUtilisationMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 154 }, "name": "memoryUsageAnnotations", "protected": true, "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": 162 }, "name": "memoryUtilisationMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 145 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 155 }, "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-ecs-patterns/FargateServiceMonitoring.ts", "line": 160 }, "name": "runningTaskCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 149 }, "name": "taskHealthAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.TaskHealthAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 151 }, "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-ecs-patterns/FargateServiceMonitoring.ts", "line": 150 }, "name": "throughputAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.ThroughputAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 143 }, "name": "title", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 152 }, "name": "usageAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.UsageAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 163 }, "name": "activeTcpFlowCountMetric", "optional": true, "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 157 }, "name": "healthyTaskCountMetric", "optional": true, "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 159 }, "name": "healthyTaskPercentMetric", "optional": true, "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 147 }, "name": "loadBalancerMetricFactory", "optional": true, "protected": true, "type": { "fqn": "cdk-monitoring-constructs.ILoadBalancerMetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 164 }, "name": "newTcpFlowCountMetric", "optional": true, "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 165 }, "name": "processedBytesMetric", "optional": true, "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 158 }, "name": "unhealthyTaskCountMetric", "optional": true, "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } ], "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.BaseMonitoringProps", "cdk-monitoring-constructs.BaseFargateServiceAlarms" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 110 }, "name": "FargateServiceMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 112 }, "name": "fargateService", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_ecs_patterns.NetworkLoadBalancedFargateService" }, { "fqn": "aws-cdk-lib.aws_ecs_patterns.ApplicationLoadBalancedFargateService" } ] } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 92 }, "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": 97 }, "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": 101 }, "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": 93 }, "name": "addUnhealthyTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UnhealthyTaskCountThreshold" }, "kind": "map" } } } ], "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": 39 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Creates annotation based on the metric and alarm properties." }, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 42 }, "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": 60 }, "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": 64 }, "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.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": 13 }, "name": "FullRestartCountThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory.ts", "line": 14 }, "name": "maxFullRestartCount", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory:FullRestartCountThreshold" }, "cdk-monitoring-constructs.GlueJobMetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.GlueJobMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 25 }, "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": 19 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 88 }, "name": "metricActiveExecutorsAverage", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 62 }, "name": "metricAverageExecutorCpuUsagePercentage", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 75 }, "name": "metricAverageExecutorMemoryUsagePercentage", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 99 }, "name": "metricCompletedStagesSum", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 110 }, "name": "metricCompletedTasksSum", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 132 }, "name": "metricFailedTasksRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 121 }, "name": "metricFailedTasksSum", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 153 }, "name": "metricKilledTasksRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 142 }, "name": "metricKilledTasksSum", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 163 }, "name": "metricMaximumNeededExecutors", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 40 }, "name": "metricTotalReadBytesFromS3", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 51 }, "name": "metricTotalWrittenBytesToS3", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "GlueJobMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 22 }, "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": 20 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 21 }, "name": "rateComputationMethod", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.RateComputationMethod" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 23 }, "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 11 }, "name": "GlueJobMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 12 }, "name": "jobName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- average", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMetricFactory.ts", "line": 16 }, "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": 68 }, "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": 47 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 210 }, "name": "createDataMovementWidget", "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-glue/GlueJobMonitoring.ts", "line": 230 }, "name": "createErrorCountWidget", "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-glue/GlueJobMonitoring.ts", "line": 241 }, "name": "createErrorRateWidget", "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-glue/GlueJobMonitoring.ts", "line": 196 }, "name": "createJobExecutionWidget", "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-glue/GlueJobMonitoring.ts", "line": 189 }, "name": "createTitleWidget", "protected": true, "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 220 }, "name": "createUtilizationWidget", "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-glue/GlueJobMonitoring.ts", "line": 162 }, "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": 173 }, "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": 60 }, "name": "activeExecutorsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 50 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 56 }, "name": "bytesReadFromS3Metric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 57 }, "name": "bytesWrittenToS3Metric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 61 }, "name": "completedStagesMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 58 }, "name": "cpuUsageMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 51 }, "name": "errorAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 53 }, "name": "errorCountAnnotations", "protected": true, "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": 54 }, "name": "errorRateAnnotations", "protected": true, "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": 63 }, "name": "failedTaskCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 64 }, "name": "failedTaskRateMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 59 }, "name": "heapMemoryUsageMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 65 }, "name": "killedTaskCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 66 }, "name": "killedTaskRateMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 62 }, "name": "neededExecutorsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 48 }, "name": "title", "protected": true, "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": 36 }, "name": "GlueJobMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-glue/GlueJobMonitoring.ts", "line": 39 }, "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": 40 }, "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": 41 }, "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": 42 }, "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": 45 }, "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": 9 }, "members": [ { "docs": { "stability": "experimental" }, "name": "LINE" }, { "docs": { "stability": "experimental" }, "name": "STACKED_AREA" }, { "docs": { "stability": "experimental" }, "name": "PIE" }, { "docs": { "stability": "experimental" }, "name": "BAR" }, { "docs": { "stability": "experimental" }, "name": "SINGLE_VALUE" } ], "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" } } ] }, "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.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.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/IAlarmActionStrategy.ts", "line": 15 }, "methods": [ { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/IAlarmActionStrategy.ts", "line": 16 }, "name": "addAlarmActions", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmActionStrategyProps" } } ] } ], "name": "IAlarmActionStrategy", "symbolId": "lib/common/alarm/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": 28 }, "methods": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Creates annotation based on the metric and alarm properties." }, "locationInModule": { "filename": "lib/common/alarm/IAlarmAnnotationStrategy.ts", "line": 33 }, "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": 89 }, "methods": [ { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/Monitoring.ts", "line": 90 }, "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.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.IEC2MetricFactoryStrategy": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.IEC2MetricFactoryStrategy", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2MetricFactory.ts", "line": 8 }, "methods": [ { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-ec2/EC2MetricFactory.ts", "line": 9 }, "name": "createMetrics", "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "metricName", "type": { "primitive": "string" } }, { "name": "statistic", "type": { "fqn": "cdk-monitoring-constructs.MetricStatistic" } } ], "returns": { "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" }, "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": 49 }, "methods": [ { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/LoadBalancerMetricFactory.ts", "line": 56 }, "name": "metricActiveConnectionCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/LoadBalancerMetricFactory.ts", "line": 50 }, "name": "metricHealthyTaskCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/LoadBalancerMetricFactory.ts", "line": 54 }, "name": "metricHealthyTaskInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/LoadBalancerMetricFactory.ts", "line": 58 }, "name": "metricNewConnectionCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/LoadBalancerMetricFactory.ts", "line": 60 }, "name": "metricProcessedBytesMin", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "abstract": true, "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/LoadBalancerMetricFactory.ts", "line": 52 }, "name": "metricUnhealthyTaskCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "ILoadBalancerMetricFactory", "symbolId": "lib/monitoring/aws-loadbalancing/LoadBalancerMetricFactory:ILoadBalancerMetricFactory" }, "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.KeyValueTableWidget": { "assembly": "cdk-monitoring-constructs", "base": "aws-cdk-lib.aws_cloudwatch.TextWidget", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.KeyValueTableWidget", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/dashboard/widget/KeyValueTableWidget.ts", "line": 6 }, "parameters": [ { "name": "data", "type": { "collection": { "elementtype": { "primitive": "json" }, "kind": "array" } } } ] }, "kind": "class", "locationInModule": { "filename": "lib/dashboard/widget/KeyValueTableWidget.ts", "line": 5 }, "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": 24 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 21 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 28 }, "name": "addIteratorMaxAgeAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 93 }, "name": "addProvisionedReadThroughputExceededAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 113 }, "name": "addProvisionedWriteThroughputExceededAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 71 }, "name": "addPutRecordsFailedAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 49 }, "name": "addPutRecordsThrottledAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 22 }, "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": 20 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory.ts", "line": 17 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory.ts", "line": 24 }, "name": "addDowntimeAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 45 }, "name": "addFullRestartAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.FullRestartCountThreshold" } }, { "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": 18 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ], "symbolId": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory:KinesisDataAnalyticsAlarmFactory" }, "cdk-monitoring-constructs.KinesisDataAnalyticsMetricFactory": { "assembly": "cdk-monitoring-constructs", "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": 25 }, "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": 21 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 86 }, "name": "metricCpuUtilizationPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 42 }, "name": "metricDowntimeMs", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 56 }, "name": "metricFullRestartsCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 93 }, "name": "metricHeapMemoryUtilizationPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 35 }, "name": "metricKPUsCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 71 }, "name": "metricLastCheckpointDurationMs", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 78 }, "name": "metricLastCheckpointSizeBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 63 }, "name": "metricNumberOfFailedCheckpointsCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 107 }, "name": "metricOldGenerationGCCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 100 }, "name": "metricOldGenerationGCTimeMs", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 49 }, "name": "metricUptimeMs", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "KinesisDataAnalyticsMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 23 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 22 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } } ], "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 5 }, "name": "KinesisDataAnalyticsMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts", "line": 6 }, "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": 62 }, "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": 43 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 178 }, "name": "createDownTimeWidget", "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-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 189 }, "name": "createFullRestartsWidget", "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-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 233 }, "name": "createGarbageCollectionWidget", "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-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 155 }, "name": "createKPUWidget", "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-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 213 }, "name": "createLastCheckpointDurationWidget", "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-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 223 }, "name": "createLastCheckpointSizeWidget", "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-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 200 }, "name": "createNumberOfFailedCheckpointsWidget", "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-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 165 }, "name": "createResourceUtilizationWidget", "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-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 147 }, "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-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 132 }, "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": 139 }, "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": 51 }, "name": "cpuUtilizationPercentMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 48 }, "name": "downtimeAnnotations", "protected": true, "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": 52 }, "name": "downtimeMsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 49 }, "name": "fullRestartAnnotations", "protected": true, "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": 53 }, "name": "fullRestartsCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 54 }, "name": "heapMemoryUtilizationPercentMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 47 }, "name": "kdaAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.KinesisDataAnalyticsAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 55 }, "name": "kpusCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 56 }, "name": "lastCheckpointDurationMsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 57 }, "name": "lastCheckpointSizeBytesMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 58 }, "name": "numberOfFailedCheckpointsCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 59 }, "name": "oldGenerationGCCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 60 }, "name": "oldGenerationGCTimeMsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 44 }, "name": "title", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 45 }, "name": "kinesisDataAnalyticsUrl", "optional": true, "protected": 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": 32 }, "name": "KinesisDataAnalyticsMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring.ts", "line": 34 }, "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": 36 }, "name": "addFullRestartCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.FullRestartCountThreshold" }, "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": 39 }, "name": "KinesisDataAnalyticsMonitoringProps", "symbolId": "lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMonitoring:KinesisDataAnalyticsMonitoringProps" }, "cdk-monitoring-constructs.KinesisDataStreamMetricFactory": { "assembly": "cdk-monitoring-constructs", "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": 18 }, "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": 14 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 39 }, "name": "metricGetRecordsIteratorAgeMaxMs", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 50 }, "name": "metricGetRecordsLatencyAverageMs", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 72 }, "name": "metricGetRecordsSuccessCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 28 }, "name": "metricGetRecordsSumBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 61 }, "name": "metricGetRecordsSumCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 83 }, "name": "metricIncomingDataSumBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 94 }, "name": "metricIncomingDataSumCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 116 }, "name": "metricPutRecordLatencyAverageMs", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 193 }, "name": "metricPutRecordsFailedRecordsCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 149 }, "name": "metricPutRecordsLatencyAverageMs", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 160 }, "name": "metricPutRecordsSuccessCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 171 }, "name": "metricPutRecordsSuccessfulRecordsCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 138 }, "name": "metricPutRecordsSumBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 204 }, "name": "metricPutRecordsThrottledRecordsCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 182 }, "name": "metricPutRecordsTotalRecordsCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 127 }, "name": "metricPutRecordSuccessCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 105 }, "name": "metricPutRecordSumBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 215 }, "name": "metricReadProvisionedThroughputExceededPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 226 }, "name": "metricWriteProvisionedThroughputExceededPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "KinesisDataStreamMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 16 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 15 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } } ], "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 7 }, "name": "KinesisDataStreamMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMetricFactory.ts", "line": 8 }, "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" } } ], "protected": true, "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" } } ], "protected": true, "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" } } ], "protected": true, "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" } } ], "protected": true, "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" } } ], "protected": true, "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" } } ], "protected": true, "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" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 237 }, "name": "createSecondAdditionalRow", "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Row" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 243 }, "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-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", "protected": true, "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", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 73 }, "name": "incomingDataSumCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 62 }, "name": "kinesisAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.KinesisAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 68 }, "name": "metricGetRecordsIteratorAge", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 69 }, "name": "metricGetRecordsLatencyAverage", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 71 }, "name": "metricGetRecordsSuccessCount", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 70 }, "name": "metricGetRecordsSumCount", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 67 }, "name": "metricGetRecordSumBytes", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 64 }, "name": "provisionedCapacityAnnotations", "protected": true, "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", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 82 }, "name": "putRecordsFailedRecordsCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 78 }, "name": "putRecordsLatencyAverageMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 79 }, "name": "putRecordsSuccessCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 81 }, "name": "putRecordsSuccessfulRecordsCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 77 }, "name": "putRecordsSumBytesMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 83 }, "name": "putRecordsThrottledRecordsCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 80 }, "name": "putRecordsTotalRecordsCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 76 }, "name": "putRecordSuccessCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 74 }, "name": "putRecordSumBytesMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 84 }, "name": "readProvisionedThroughputExceededMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 65 }, "name": "recordCountAnnotations", "protected": true, "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", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 85 }, "name": "writeProvisionedThroughputExceededMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisDataStreamMonitoring.ts", "line": 60 }, "name": "streamUrl", "optional": true, "protected": 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.KinesisFirehoseMetricFactory": { "assembly": "cdk-monitoring-constructs", "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": 18 }, "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": 14 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 149 }, "name": "metricBytesPerSecondLimit", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 39 }, "name": "metricFailedConversionCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 50 }, "name": "metricIncomingBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 116 }, "name": "metricIncomingBytesToLimitRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 61 }, "name": "metricIncomingPutRequests", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 138 }, "name": "metricIncomingPutRequestsToLimitRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 72 }, "name": "metricIncomingRecordCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 127 }, "name": "metricIncomingRecordsToLimitRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 105 }, "name": "metricPutRecordBatchLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 94 }, "name": "metricPutRecordLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 171 }, "name": "metricPutRequestsPerSecondLimit", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 160 }, "name": "metricRecordsPerSecondLimit", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 28 }, "name": "metricSuccessfulConversionCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 83 }, "name": "metricThrottledRecordCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "KinesisFirehoseMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 16 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 15 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } } ], "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 7 }, "name": "KinesisFirehoseMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMetricFactory.ts", "line": 8 }, "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": 57 }, "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": 39 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 156 }, "name": "createConversionWidget", "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-kinesis/KinesisFirehoseMonitoring.ts", "line": 135 }, "name": "createIncomingRecordWidget", "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-kinesis/KinesisFirehoseMonitoring.ts", "line": 146 }, "name": "createLatencyWidget", "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-kinesis/KinesisFirehoseMonitoring.ts", "line": 166 }, "name": "createLimitWidget", "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-kinesis/KinesisFirehoseMonitoring.ts", "line": 127 }, "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-kinesis/KinesisFirehoseMonitoring.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-kinesis/KinesisFirehoseMonitoring.ts", "line": 117 }, "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": 50 }, "name": "failedConversionMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 46 }, "name": "incomingBytesMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 53 }, "name": "incomingBytesToLimitRate", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 55 }, "name": "incomingPutRequestsToLimitRate", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 47 }, "name": "incomingRecordsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 54 }, "name": "incomingRecordsToLimitRate", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 43 }, "name": "kinesisAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.KinesisAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 52 }, "name": "putRecordBatchLatency", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 51 }, "name": "putRecordLatency", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 44 }, "name": "recordCountAnnotations", "protected": true, "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": 49 }, "name": "successfulConversionMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 48 }, "name": "throttledRecordsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 40 }, "name": "title", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 41 }, "name": "streamUrl", "optional": true, "protected": 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": 31 }, "name": "KinesisFirehoseMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts", "line": 32 }, "name": "addRecordsThrottledAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.RecordsThrottledThreshold" }, "kind": "map" } } } ], "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": 35 }, "name": "KinesisFirehoseMonitoringProps", "symbolId": "lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring:KinesisFirehoseMonitoringProps" }, "cdk-monitoring-constructs.LambdaFunctionEnhancedMetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.LambdaFunctionEnhancedMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 11 }, "parameters": [ { "name": "metricFactory", "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "name": "lambdaFunction", "type": { "fqn": "aws-cdk-lib.aws_lambda.IFunction" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 7 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 32 }, "name": "enhancedMetricAvgCpuTotalTime", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 56 }, "name": "enhancedMetricAvgMemoryUtilization", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 64 }, "name": "enhancedMetricFunctionCost", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 16 }, "name": "enhancedMetricMaxCpuTotalTime", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 40 }, "name": "enhancedMetricMaxMemoryUtilization", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 24 }, "name": "enhancedMetricP90CpuTotalTime", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 48 }, "name": "enhancedMetricP90MemoryUtilization", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "LambdaFunctionEnhancedMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 9 }, "name": "lambdaFunction", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_lambda.IFunction" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory.ts", "line": 8 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } } ], "symbolId": "lib/monitoring/aws-lambda/LambdaFunctionEnhancedMetricFactory:LambdaFunctionEnhancedMetricFactory" }, "cdk-monitoring-constructs.LambdaFunctionMetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.LambdaFunctionMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 36 }, "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": 30 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 141 }, "name": "metricConcurrentExecutions", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 96 }, "name": "metricFaultCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 104 }, "name": "metricFaultRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 60 }, "name": "metricInvocationRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 132 }, "name": "metricLatencyP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 123 }, "name": "metricLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 114 }, "name": "metricLatencyP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 169 }, "name": "metricMaxIteratorAgeInMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 150 }, "name": "metricProvisionedConcurrencySpilloverInvocations", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 159 }, "name": "metricProvisionedConcurrencySpilloverRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 78 }, "name": "metricThrottlesCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 86 }, "name": "metricThrottlesRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "deprecated": "use metricInvocationRate", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 50 }, "name": "metricTps", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "LambdaFunctionMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 33 }, "name": "fillTpsWithZeroes", "protected": true, "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 32 }, "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": 31 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 34 }, "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 9 }, "name": "LambdaFunctionMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts", "line": 10 }, "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": 14 }, "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": 27 }, "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": 18 }, "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": 163 }, "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": 115 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 554 }, "name": "createErrorCountWidget", "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-lambda/LambdaFunctionMonitoring.ts", "line": 565 }, "name": "createErrorRateWidget", "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-lambda/LambdaFunctionMonitoring.ts", "line": 590 }, "name": "createInvocationWidget", "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-lambda/LambdaFunctionMonitoring.ts", "line": 606 }, "name": "createIteratorAgeWidget", "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-lambda/LambdaFunctionMonitoring.ts", "line": 617 }, "name": "createLambdaInsightsCpuWidget", "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-lambda/LambdaFunctionMonitoring.ts", "line": 649 }, "name": "createLambdaInsightsFunctionCostWidget", "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-lambda/LambdaFunctionMonitoring.ts", "line": 633 }, "name": "createLambdaInsightsMemoryWidget", "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-lambda/LambdaFunctionMonitoring.ts", "line": 539 }, "name": "createLatencyWidget", "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-lambda/LambdaFunctionMonitoring.ts", "line": 576 }, "name": "createRateWidget", "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-lambda/LambdaFunctionMonitoring.ts", "line": 520 }, "name": "createTitleWidget", "protected": true, "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 528 }, "name": "createTpsWidget", "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-lambda/LambdaFunctionMonitoring.ts", "line": 473 }, "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": 482 }, "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": 126 }, "name": "ageAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AgeAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 121 }, "name": "alarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 148 }, "name": "concurrentExecutionsCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 135 }, "name": "cpuTotalTimeAnnotations", "protected": true, "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": 122 }, "name": "errorAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 130 }, "name": "errorCountAnnotations", "protected": true, "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": 131 }, "name": "errorRateAnnotations", "protected": true, "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": 143 }, "name": "faultCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 144 }, "name": "faultRateMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 132 }, "name": "invocationCountAnnotations", "protected": true, "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": 145 }, "name": "invocationCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 133 }, "name": "invocationRateAnnotations", "protected": true, "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": 153 }, "name": "lambdaInsightsEnabled", "protected": true, "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 123 }, "name": "latencyAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 129 }, "name": "latencyAnnotations", "protected": true, "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": 137 }, "name": "maxIteratorAgeAnnotations", "protected": true, "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": 151 }, "name": "maxIteratorAgeMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 136 }, "name": "memoryUsageAnnotations", "protected": true, "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": 120 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.LambdaFunctionMetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 119 }, "name": "namingStrategy", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringNamingStrategy" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 140 }, "name": "p50LatencyMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 141 }, "name": "p90LatencyMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 142 }, "name": "p99LatencyMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 149 }, "name": "provisionedConcurrencySpilloverInvocationsCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 150 }, "name": "provisionedConcurrencySpilloverInvocationsRateMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 125 }, "name": "taskHealthAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.TaskHealthAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 146 }, "name": "throttlesCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 147 }, "name": "throttlesRateMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 116 }, "name": "title", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 124 }, "name": "tpsAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.TpsAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 134 }, "name": "tpsAnnotations", "protected": true, "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": 139 }, "name": "tpsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 127 }, "name": "usageAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.UsageAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 154 }, "name": "enhancedMetricFactory", "optional": true, "protected": true, "type": { "fqn": "cdk-monitoring-constructs.LambdaFunctionEnhancedMetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 161 }, "name": "enhancedMetricFunctionCostMetric", "optional": true, "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 157 }, "name": "enhancedMonitoringAvgCpuTotalTimeMetric", "optional": true, "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 160 }, "name": "enhancedMonitoringAvgMemoryUtilizationMetric", "optional": true, "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 155 }, "name": "enhancedMonitoringMaxCpuTotalTimeMetric", "optional": true, "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 158 }, "name": "enhancedMonitoringMaxMemoryUtilizationMetric", "optional": true, "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 156 }, "name": "enhancedMonitoringP90CpuTotalTimeMetric", "optional": true, "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 159 }, "name": "enhancedMonitoringP90MemoryUtilizationMetric", "optional": true, "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 117 }, "name": "functionUrl", "optional": true, "protected": 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": 54 }, "name": "LambdaFunctionMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-lambda/LambdaFunctionMonitoring.ts", "line": 68 }, "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": 91 }, "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": 105 }, "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": 83 }, "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": 97 }, "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": 87 }, "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": 101 }, "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": 59 }, "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": 60 }, "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": 63 }, "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": 55 }, "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-lambda/LambdaFunctionMonitoring.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-lambda/LambdaFunctionMonitoring.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-lambda/LambdaFunctionMonitoring.ts", "line": 62 }, "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": 80 }, "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": 72 }, "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": 76 }, "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": 65 }, "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": 66 }, "name": "addThrottlesRateAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.ErrorRateThreshold" }, "kind": "map" } } } ], "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": 111 }, "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": 123 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/LatencyAlarmFactory.ts", "line": 120 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/LatencyAlarmFactory.ts", "line": 181 }, "name": "addDurationAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.DurationThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/LatencyAlarmFactory.ts", "line": 154 }, "name": "addIntegrationLatencyAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/LatencyAlarmFactory.ts", "line": 208 }, "name": "addJvmGarbageCollectionDurationAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.DurationThreshold" } }, { "name": "disambiguator", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.AlarmWithAnnotation" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/LatencyAlarmFactory.ts", "line": 127 }, "name": "addLatencyAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "name": "latencyType", "type": { "fqn": "cdk-monitoring-constructs.LatencyType" } }, { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.LatencyThreshold" } }, { "name": "disambiguator", "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": 121 }, "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": 112 }, "name": "LatencyThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/LatencyAlarmFactory.ts", "line": 113 }, "name": "maxLatency", "type": { "fqn": "aws-cdk-lib.Duration" } } ], "symbolId": "lib/common/monitoring/alarms/LatencyAlarmFactory:LatencyThreshold" }, "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": "AVERAGE" } ], "name": "LatencyType", "symbolId": "lib/common/monitoring/alarms/LatencyAlarmFactory:LatencyType" }, "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 50 }, "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": 43 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 88 }, "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 main dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 62 }, "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": 48 }, "name": "limit", "protected": true, "type": { "primitive": "number" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 45 }, "name": "logGroupName", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 44 }, "name": "pattern", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 46 }, "name": "logGroupUrl", "optional": true, "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 47 }, "name": "title", "optional": true, "protected": 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" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 14 }, "name": "LogMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "name of the log group to analyze for the given pattern." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 18 }, "name": "logGroupName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "pattern to show, e.g. \"ERROR\"." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 23 }, "name": "pattern", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- 10", "stability": "experimental", "summary": "number of log messages to search for." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-cloudwatch/LogMonitoring.ts", "line": 37 }, "name": "limit", "optional": true, "type": { "primitive": "number" } }, { "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": 30 }, "name": "title", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/monitoring/aws-cloudwatch/LogMonitoring:LogMonitoringProps" }, "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.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": 9 }, "name": "MaxDowntimeThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory.ts", "line": 10 }, "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.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.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": 17 }, "name": "MaxUsedSwapMemoryThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory.ts", "line": 18 }, "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": 45 }, "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactoryProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 42 }, "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": 194 }, "name": "adaptMetric", "parameters": [ { "docs": { "summary": "metric to be adapted." }, "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "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": 206 }, "name": "adaptMetricPreservingPeriod", "parameters": [ { "docs": { "summary": "metric to be adapted." }, "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "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": 407 }, "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": 60 }, "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" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "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": 168 }, "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" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "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": 91 }, "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" } } ], "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "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": 119 }, "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" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" } } }, { "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": 254 }, "name": "divideMetric", "parameters": [ { "docs": { "summary": "metric to multiply." }, "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "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": 381 }, "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": 221 }, "name": "multiplyMetric", "parameters": [ { "docs": { "summary": "metric to multiply." }, "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "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": 397 }, "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": 288 }, "name": "toRate", "parameters": [ { "docs": { "summary": "metric to calculate the rate from." }, "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "MetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 43 }, "name": "globalDefaults", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactoryDefaults" } } ], "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", "kind": "interface", "locationInModule": { "filename": "lib/common/metric/MetricFactory.ts", "line": 22 }, "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": 26 }, "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": 32 }, "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": 35 }, "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": 39 }, "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 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.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": 13 }, "name": "MinFreeableMemoryThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory.ts", "line": 14 }, "name": "minFreeableMemoryInBytes", "type": { "primitive": "number" } } ], "symbolId": "lib/common/monitoring/alarms/ElastiCacheAlarmFactory:MinFreeableMemoryThreshold" }, "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.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": 19 }, "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" ], "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/Monitoring.ts", "line": 14 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Adds an alarm." }, "locationInModule": { "filename": "lib/common/monitoring/Monitoring.ts", "line": 54 }, "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": 68 }, "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": 44 }, "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": 61 }, "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": 35 }, "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": 28 }, "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": 79 }, "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": 86 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.IDashboardSegment", "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": 16 }, "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": 15 }, "name": "scope", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringScope" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/Monitoring.ts", "line": 17 }, "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": 42 }, "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": 36 }, "methods": [ { "docs": { "stability": "experimental", "summary": "All aspects can visit an IConstruct." }, "locationInModule": { "filename": "lib/facade/MonitoringAspect.ts", "line": 47 }, "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/aspect-types.ts", "line": 45 }, "name": "MonitoringAspectProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 46 }, "name": "acm", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 47 }, "name": "apiGateway", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 48 }, "name": "apiGatewayV2", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 49 }, "name": "appSync", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 50 }, "name": "autoScalingGroup", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 51 }, "name": "billing", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 52 }, "name": "cloudFront", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 53 }, "name": "codeBuild", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 54 }, "name": "documentDb", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 55 }, "name": "dynamoDB", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 56 }, "name": "ec2", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 57 }, "name": "elasticCache", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 58 }, "name": "glue", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 59 }, "name": "kinesisDataAnalytics", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 60 }, "name": "kinesisDataStream", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 61 }, "name": "kinesisFirehose", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 62 }, "name": "lambda", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 63 }, "name": "openSearch", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 64 }, "name": "rds", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 65 }, "name": "redshift", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 66 }, "name": "s3", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 67 }, "name": "secretsManager", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 68 }, "name": "sns", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 69 }, "name": "sqs", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 70 }, "name": "stepFunctions", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 71 }, "name": "syntheticsCanaries", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 72 }, "name": "webApplicationFirewallAclV2", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectType" } } ], "symbolId": "lib/facade/aspect-types:MonitoringAspectProps" }, "cdk-monitoring-constructs.MonitoringAspectType": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.MonitoringAspectType", "kind": "interface", "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 31 }, "name": "MonitoringAspectType", "properties": [ { "abstract": true, "docs": { "default": "- true", "stability": "experimental", "summary": "If the monitoring aspect is enabled for this resource." }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 36 }, "name": "enabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- none", "stability": "experimental", "summary": "The monitoring props for this resource." }, "immutable": true, "locationInModule": { "filename": "lib/facade/aspect-types.ts", "line": 42 }, "name": "props", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "lib/facade/aspect-types:MonitoringAspectType" }, "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": 31 }, "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": 36 }, "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": 78 }, "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": 64 }, "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": 71 }, "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": 47 }, "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": 42 }, "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": 84 }, "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": 57 }, "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": 52 }, "name": "summaryDashboardRange", "optional": true, "type": { "fqn": "aws-cdk-lib.Duration" } } ], "symbolId": "lib/dashboard/DefaultDashboardFactory:MonitoringDashboardsProps" }, "cdk-monitoring-constructs.MonitoringFacade": { "assembly": "cdk-monitoring-constructs", "base": "cdk-monitoring-constructs.MonitoringScope", "docs": { "stability": "experimental", "summary": "Main entry point to create your monitoring." }, "fqn": "cdk-monitoring-constructs.MonitoringFacade", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 144 }, "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": 138 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 322 }, "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": 331 }, "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" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 313 }, "name": "addSegment", "parameters": [ { "name": "segment", "type": { "fqn": "cdk-monitoring-constructs.IDashboardSegment" } }, { "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": 340 }, "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": 349 }, "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": { "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": 185 }, "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": 193 }, "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": 288 }, "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": 264 }, "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": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 219 }, "name": "createdAlarmDashboard", "returns": { "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" } } }, { "docs": { "stability": "experimental", "summary": "Returns the created alarms across all the monitorings added up until now." }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 226 }, "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": 250 }, "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": 240 }, "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" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 211 }, "name": "createdDashboard", "returns": { "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard" } } }, { "docs": { "stability": "experimental", "summary": "Returns the created monitorings added up until now." }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 307 }, "name": "createdMonitorings", "returns": { "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.Monitoring" }, "kind": "array" } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 215 }, "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": 200 }, "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": 204 }, "name": "createWidgetFactory", "overrides": "cdk-monitoring-constructs.MonitoringScope", "returns": { "type": { "fqn": "cdk-monitoring-constructs.IWidgetFactory" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 359 }, "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": 365 }, "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": 371 }, "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": 553 }, "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": 677 }, "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": 377 }, "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": 383 }, "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": 389 }, "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": 683 }, "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": 395 }, "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": 401 }, "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": 407 }, "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": 522 }, "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": 415 }, "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": 511 }, "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": 491 }, "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": 433 }, "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": 421 }, "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": 478 }, "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": 465 }, "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": 445 }, "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": 439 }, "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": 571 }, "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": 565 }, "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": 559 }, "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": 577 }, "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": 659 }, "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": 583 }, "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": 427 }, "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": 544 }, "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": 535 }, "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": 589 }, "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": 595 }, "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": 653 }, "name": "monitorS3Bucket", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.S3BucketMonitoringProps" } } ], "returns": { "type": { "fqn": "cdk-monitoring-constructs.MonitoringFacade" } } }, { "docs": { "stability": "experimental", "summary": "Monitor all the resources in the given scope." }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 695 }, "name": "monitorScope", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "aspectProps", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.MonitoringAspectProps" } } ] }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 601 }, "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": 502 }, "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": 456 }, "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": 607 }, "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": 613 }, "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": 619 }, "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": 625 }, "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": 631 }, "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": 637 }, "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": 645 }, "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": 665 }, "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": 671 }, "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": 140 }, "name": "alarmFactoryDefaults", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactoryDefaults" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 142 }, "name": "createdSegments", "protected": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.IDashboardSegment" }, "kind": "array" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 139 }, "name": "metricFactoryDefaults", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactoryDefaults" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 141 }, "name": "dashboardFactory", "optional": true, "protected": true, "type": { "fqn": "cdk-monitoring-constructs.IDashboardFactory" } } ], "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": 115 }, "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": 126 }, "name": "alarmFactoryDefaults", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.AlarmFactoryDefaults" } }, { "abstract": true, "docs": { "default": "- `DefaultDashboardFactory`; facade logical ID used as default name", "stability": "experimental", "summary": "Defaults for dashboard factory." }, "immutable": true, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 132 }, "name": "dashboardFactory", "optional": true, "type": { "fqn": "cdk-monitoring-constructs.IDashboardFactory" } }, { "abstract": true, "docs": { "default": "- empty (no preferences)", "stability": "experimental", "summary": "Defaults for metric factory." }, "immutable": true, "locationInModule": { "filename": "lib/facade/MonitoringFacade.ts", "line": 120 }, "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": 10 }, "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.MonitoringHeaderWidgetProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/dashboard/widget/MonitoringHeaderWidget.ts", "line": 9 }, "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": 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": { "stability": "experimental", "summary": "A scope (construct) where all monitoring constructs are living in." }, "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": 11 }, "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": 27 }, "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": 32 }, "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": 20 }, "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": 15 }, "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/MultipleAlarmActionStrategy.ts", "line": 16 }, "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/MultipleAlarmActionStrategy.ts", "line": 13 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/MultipleAlarmActionStrategy.ts", "line": 20 }, "name": "addAlarmActions", "overrides": "cdk-monitoring-constructs.IAlarmActionStrategy", "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.AlarmActionStrategyProps" } } ] } ], "name": "MultipleAlarmActionStrategy", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/alarm/MultipleAlarmActionStrategy.ts", "line": 14 }, "name": "actions", "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.IAlarmActionStrategy" }, "kind": "array" } } } ], "symbolId": "lib/common/alarm/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.NetworkLoadBalancerMetricFactory": { "assembly": "cdk-monitoring-constructs", "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": 32 }, "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": 25 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 71 }, "name": "metricActiveConnectionCount", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 41 }, "name": "metricHealthyTaskCount", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 61 }, "name": "metricHealthyTaskInPercent", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 79 }, "name": "metricNewConnectionCount", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 87 }, "name": "metricProcessedBytesMin", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 51 }, "name": "metricUnhealthyTaskCount", "overrides": "cdk-monitoring-constructs.ILoadBalancerMetricFactory", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "NetworkLoadBalancerMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 28 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 29 }, "name": "networkLoadBalancer", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.NetworkLoadBalancer" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 30 }, "name": "networkTargetGroup", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.NetworkTargetGroup" } } ], "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 17 }, "name": "NetworkLoadBalancerMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 18 }, "name": "networkLoadBalancer", "type": { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.NetworkLoadBalancer" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMetricFactory.ts", "line": 19 }, "name": "networkTargetGroup", "type": { "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.NetworkTargetGroup" } } ], "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": 67 }, "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": 51 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 171 }, "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": 182 }, "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": 164 }, "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": 148 }, "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": 156 }, "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": 63 }, "name": "activeTcpFlowCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 60 }, "name": "healthyTaskCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 62 }, "name": "healthyTaskPercentMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 52 }, "name": "humanReadableName", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 53 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.NetworkLoadBalancerMetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 64 }, "name": "newTcpFlowCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 58 }, "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": 65 }, "name": "processedBytesMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 55 }, "name": "taskHealthAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.TaskHealthAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 57 }, "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": 56 }, "name": "throughputAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.ThroughputAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 61 }, "name": "unhealthyTaskCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } ], "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": 33 }, "name": "NetworkLoadBalancerMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring.ts", "line": 36 }, "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": 41 }, "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": 45 }, "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": 37 }, "name": "addUnhealthyTaskCountAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UnhealthyTaskCountThreshold" }, "kind": "map" } } } ], "symbolId": "lib/monitoring/aws-loadbalancing/NetworkLoadBalancerMonitoring:NetworkLoadBalancerMonitoringProps" }, "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/NoopAlarmActionStrategy.ts", "line": 13 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/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/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": { "see": "https://github.com/aws/aws-cdk/releases/tag/v1.73.0", "stability": "experimental", "summary": "Backported set of metric functions added in @aws-cdk/aws-elasticsearch@1.65.0." }, "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_elasticsearch.IDomain" }, { "fqn": "aws-cdk-lib.aws_elasticsearch.CfnDomain" }, { "fqn": "aws-cdk-lib.aws_opensearchservice.IDomain" }, { "fqn": "aws-cdk-lib.aws_opensearchservice.CfnDomain" } ] } } } ] }, "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.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", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.OpenSearchClusterMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 31 }, "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": 25 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 210 }, "name": "metricAutomatedSnapshotFailure", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "deprecated": "use metricClusterIndexWritesBlocked instead", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 198 }, "name": "metricClusterIndexWriteBlocked", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 187 }, "name": "metricClusterIndexWritesBlocked", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 125 }, "name": "metricClusterStatusRed", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 133 }, "name": "metricClusterStatusYellow", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 155 }, "name": "metricCpuUsage", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 141 }, "name": "metricDiskSpaceUsageInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 71 }, "name": "metricIndexingLatencyP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 80 }, "name": "metricIndexingLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 89 }, "name": "metricIndexingLatencyP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 171 }, "name": "metricJvmMemoryPressure", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 218 }, "name": "metricKmsKeyError", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 226 }, "name": "metricKmsKeyInaccessible", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 163 }, "name": "metricMasterCpuUsage", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 179 }, "name": "metricMasterJvmMemoryPressure", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 202 }, "name": "metricNodes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 42 }, "name": "metricSearchCount", "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 98 }, "name": "metricSearchLatencyP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 107 }, "name": "metricSearchLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 116 }, "name": "metricSearchLatencyP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 48 }, "name": "metricSearchRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "deprecated": "use metricSearchRate", "stability": "deprecated" }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 61 }, "name": "metricTps", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "OpenSearchClusterMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 27 }, "name": "domainMetrics", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.OpenSearchBackportedMetrics" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 28 }, "name": "fillTpsWithZeroes", "protected": true, "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 26 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 29 }, "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 13 }, "name": "OpenSearchClusterMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 14 }, "name": "domain", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_elasticsearch.IDomain" }, { "fqn": "aws-cdk-lib.aws_elasticsearch.CfnDomain" }, { "fqn": "aws-cdk-lib.aws_opensearchservice.IDomain" }, { "fqn": "aws-cdk-lib.aws_opensearchservice.CfnDomain" } ] } } }, { "abstract": true, "docs": { "default": "- true", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMetricFactory.ts", "line": 18 }, "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": 22 }, "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": 125 }, "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": 87 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 394 }, "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": 458 }, "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": 121 }, "name": "automatedSnapshotFailureMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 95 }, "name": "clusterAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.OpenSearchClusterAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 96 }, "name": "clusterAnnotations", "protected": true, "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": 110 }, "name": "clusterStatusRedMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 111 }, "name": "clusterStatusYellowMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 114 }, "name": "cpuUsageMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 113 }, "name": "diskSpaceUsageMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 91 }, "name": "indexingLatencyAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 92 }, "name": "indexingLatencyAnnotations", "protected": true, "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": 119 }, "name": "indexWriteBlockedMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 116 }, "name": "jvmMemoryPressureMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 122 }, "name": "kmsKeyErrorMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 123 }, "name": "kmsKeyInaccessibleMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 115 }, "name": "masterCpuUsageMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 117 }, "name": "masterJvmMemoryPressureMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 100 }, "name": "masterUsageAnnotations", "protected": true, "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": 97 }, "name": "nodeAnnotations", "protected": true, "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": "nodesMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 103 }, "name": "p50IndexingLatencyMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 106 }, "name": "p50SearchLatencyMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 104 }, "name": "p90IndexingLatencyMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 107 }, "name": "p90SearchLatencyMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 105 }, "name": "p99IndexingLatencyMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 108 }, "name": "p99SearchLatencyMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 93 }, "name": "searchLatencyAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 94 }, "name": "searchLatencyAnnotations", "protected": true, "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": 88 }, "name": "title", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 102 }, "name": "tpsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 98 }, "name": "usageAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.UsageAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 99 }, "name": "usageAnnotations", "protected": true, "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": "url", "optional": true, "protected": 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": 44 }, "name": "OpenSearchClusterMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-opensearch/OpenSearchClusterMonitoring.ts", "line": 71 }, "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": 63 }, "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": 67 }, "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": 53 }, "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": 58 }, "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": 57 }, "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": 46 }, "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": 47 }, "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": 48 }, "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": 60 }, "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": 76 }, "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": 77 }, "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": 59 }, "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": 61 }, "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": 49 }, "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": 50 }, "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": 51 }, "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": 83 }, "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.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.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/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/OpsItemAlarmActionStrategy.ts", "line": 63 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/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/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/OpsItemAlarmActionStrategy.ts", "line": 72 }, "name": "category", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch_actions.OpsItemCategory" } } ], "symbolId": "lib/common/alarm/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": 142 }, "name": "addMaxQueueIncomingMessagesCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 104 }, "name": "addMaxQueueTimeToDrainMessagesAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 123 }, "name": "addMinQueueIncomingMessagesCountAlarm", "parameters": [ { "name": "metric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 32 }, "name": "QueueProcessingEc2ServiceMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/misc.ts", "line": 34 }, "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.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": 27 }, "name": "QueueProcessingFargateServiceMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/misc.ts", "line": 29 }, "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.RdsClusterMetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RdsClusterMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 25 }, "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": 20 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 80 }, "name": "metricAverageCpuUsageInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 100 }, "name": "metricCommitLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 96 }, "name": "metricDeleteLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 70 }, "name": "metricDiskSpaceUsageInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 62 }, "name": "metricFreeStorageInBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 88 }, "name": "metricInsertLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 84 }, "name": "metricSelectLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 54 }, "name": "metricTotalConnectionCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 92 }, "name": "metricUpdateLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 66 }, "name": "metricUsedStorageInBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "RdsClusterMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 21 }, "name": "clusterIdentifier", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 23 }, "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": 22 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } } ], "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMetricFactory.ts", "line": 8 }, "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": 17 }, "name": "cluster", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_rds.IDatabaseCluster" } }, { "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": 13 }, "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": 57 }, "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": 41 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 150 }, "name": "createConnectionsWidget", "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-rds/RdsClusterMonitoring.ts", "line": 139 }, "name": "createCpuAndDiskUsageWidget", "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-rds/RdsClusterMonitoring.ts", "line": 160 }, "name": "createLatencyWidget", "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-rds/RdsClusterMonitoring.ts", "line": 131 }, "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-rds/RdsClusterMonitoring.ts", "line": 113 }, "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": 122 }, "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": 55 }, "name": "commitLatencyMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 48 }, "name": "connectionsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 50 }, "name": "cpuUsageMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 54 }, "name": "deleteLatencyMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 49 }, "name": "diskSpaceUsageMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 52 }, "name": "insertLatencyMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 51 }, "name": "selectLatencyMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 42 }, "name": "title", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 53 }, "name": "updateLatencyMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 45 }, "name": "usageAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.UsageAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 46 }, "name": "usageAnnotations", "protected": true, "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": 43 }, "name": "url", "optional": true, "protected": 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": 32 }, "name": "RdsClusterMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-rds/RdsClusterMonitoring.ts", "line": 34 }, "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": 33 }, "name": "addDiskSpaceUsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "kind": "map" } } } ], "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": 37 }, "name": "RdsClusterMonitoringProps", "symbolId": "lib/monitoring/aws-rds/RdsClusterMonitoring:RdsClusterMonitoringProps" }, "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": 17 }, "name": "RecordsFailedThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/KinesisAlarmFactory.ts", "line": 18 }, "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.RedshiftClusterMetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.RedshiftClusterMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 17 }, "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": 13 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 43 }, "name": "metricAverageCpuUsageInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 35 }, "name": "metricAverageDiskSpaceUsageInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 73 }, "name": "metricLongQueryDurationP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 86 }, "name": "metricMaintenanceModeEnabled", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 60 }, "name": "metricMediumQueryDurationP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 90 }, "name": "metricReadLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 47 }, "name": "metricShortQueryDurationP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 27 }, "name": "metricTotalConnectionCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 104 }, "name": "metricWriteLatencyP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "RedshiftClusterMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 15 }, "name": "dimensionsMap", "protected": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 14 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } } ], "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 9 }, "name": "RedshiftClusterMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMetricFactory.ts", "line": 10 }, "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": 60 }, "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": 42 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 159 }, "name": "createConnectionsWidget", "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-redshift/RedshiftClusterMonitoring.ts", "line": 148 }, "name": "createCpuAndDiskUsageWidget", "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-redshift/RedshiftClusterMonitoring.ts", "line": 183 }, "name": "createLatencyWidget", "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-redshift/RedshiftClusterMonitoring.ts", "line": 193 }, "name": "createMaintenanceWidget", "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-redshift/RedshiftClusterMonitoring.ts", "line": 169 }, "name": "createQueryDurationWidget", "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-redshift/RedshiftClusterMonitoring.ts", "line": 140 }, "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-redshift/RedshiftClusterMonitoring.ts", "line": 120 }, "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": 129 }, "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": 49 }, "name": "connectionsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 51 }, "name": "cpuUsageMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 50 }, "name": "diskSpaceUsageMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 54 }, "name": "longQueryDurationMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 58 }, "name": "maintenanceModeMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 53 }, "name": "mediumQueryDurationMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 55 }, "name": "readLatencyMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 52 }, "name": "shortQueryDurationMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 43 }, "name": "title", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 46 }, "name": "usageAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.UsageAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 47 }, "name": "usageAnnotations", "protected": true, "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": 56 }, "name": "writeLatencyMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 44 }, "name": "url", "optional": true, "protected": 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": 33 }, "name": "RedshiftClusterMonitoringOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring.ts", "line": 35 }, "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": 34 }, "name": "addDiskSpaceUsageAlarm", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk-monitoring-constructs.UsageThreshold" }, "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": 38 }, "name": "RedshiftClusterMonitoringProps", "symbolId": "lib/monitoring/aws-redshift/RedshiftClusterMonitoring:RedshiftClusterMonitoringProps" }, "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.S3BucketMetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.S3BucketMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMetricFactory.ts", "line": 35 }, "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": 31 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMetricFactory.ts", "line": 40 }, "name": "metricBucketSizeBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMetricFactory.ts", "line": 54 }, "name": "metricNumberOfObjects", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "S3BucketMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMetricFactory.ts", "line": 32 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMetricFactory.ts", "line": 33 }, "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMetricFactory.ts", "line": 26 }, "name": "S3BucketMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-s3/S3BucketMetricFactory.ts", "line": 27 }, "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": 28 }, "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.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": 21 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerMetricsPublisher.ts", "line": 71 }, "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": 82 }, "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": 23 }, "name": "lambda", "type": { "fqn": "aws-cdk-lib.aws_lambda.IFunction" } } ], "symbolId": "lib/monitoring/aws-secretsmanager/SecretsManagerMetricsPublisher:SecretsManagerMetricsPublisher" }, "cdk-monitoring-constructs.SecretsManagerSecretMetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SecretsManagerSecretMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMetricFactory.ts", "line": 18 }, "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": 10 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMetricFactory.ts", "line": 29 }, "name": "metricDaysSinceLastChange", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMetricFactory.ts", "line": 40 }, "name": "metricDaysSinceLastRotation", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "SecretsManagerSecretMetricFactory", "properties": [ { "const": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMetricFactory.ts", "line": 12 }, "name": "MetricNameDaysSinceLastChange", "static": true, "type": { "primitive": "string" } }, { "const": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMetricFactory.ts", "line": 13 }, "name": "MetricNameDaysSinceLastRotation", "static": true, "type": { "primitive": "string" } }, { "const": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMetricFactory.ts", "line": 11 }, "name": "Namespace", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMetricFactory.ts", "line": 15 }, "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": 14 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMetricFactory.ts", "line": 16 }, "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMetricFactory.ts", "line": 6 }, "name": "SecretsManagerSecretMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-secretsmanager/SecretsManagerSecretMetricFactory.ts", "line": 7 }, "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", "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": 65 }, "name": "title", "protected": true, "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": 82 }, "name": "SimpleEc2ServiceMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/Ec2ServiceMonitoring.ts", "line": 84 }, "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.BaseMonitoringProps", "cdk-monitoring-constructs.BaseFargateServiceAlarms" ], "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 82 }, "name": "SimpleFargateServiceMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-ecs-patterns/FargateServiceMonitoring.ts", "line": 84 }, "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": 26 }, "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.SingleAxisGraphWidgetProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 25 }, "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": 10 }, "name": "SingleAxisGraphWidgetProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 13 }, "name": "height", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 15 }, "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": 14 }, "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": 12 }, "name": "width", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/widget/StrictGraphWidget.ts", "line": 16 }, "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": 11 }, "name": "title", "optional": true, "type": { "primitive": "string" } } ], "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" }, "locationInModule": { "filename": "lib/dashboard/SingleWidgetDashboardSegment.ts", "line": 10 }, "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" } } ] }, "interfaces": [ "cdk-monitoring-constructs.IDashboardSegment" ], "kind": "class", "locationInModule": { "filename": "lib/dashboard/SingleWidgetDashboardSegment.ts", "line": 5 }, "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": 16 }, "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": 23 }, "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": 30 }, "name": "widgets", "overrides": "cdk-monitoring-constructs.IDashboardSegment", "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": 8 }, "name": "addToAlarm", "protected": true, "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/SingleWidgetDashboardSegment.ts", "line": 7 }, "name": "addToSummary", "protected": true, "type": { "primitive": "boolean" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/dashboard/SingleWidgetDashboardSegment.ts", "line": 6 }, "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/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/SnsAlarmActionStrategy.ts", "line": 45 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/alarm/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/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/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/SnsAlarmActionStrategy.ts", "line": 47 }, "name": "onOkTopic", "optional": true, "protected": true, "type": { "fqn": "aws-cdk-lib.aws_sns.ITopic" } } ], "symbolId": "lib/common/alarm/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/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/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/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/SnsAlarmActionStrategy.ts", "line": 32 }, "name": "onOkTopic", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_sns.ITopic" } } ], "symbolId": "lib/common/alarm/SnsAlarmActionStrategy:SnsAlarmActionStrategyProps" }, "cdk-monitoring-constructs.SnsTopicMetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SnsTopicMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMetricFactory.ts", "line": 13 }, "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": 9 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMetricFactory.ts", "line": 34 }, "name": "metricAverageMessageSizeInBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMetricFactory.ts", "line": 18 }, "name": "metricIncomingMessageCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMetricFactory.ts", "line": 42 }, "name": "metricNumberOfNotificationsFailed", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMetricFactory.ts", "line": 26 }, "name": "metricOutgoingMessageCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "SnsTopicMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMetricFactory.ts", "line": 10 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMetricFactory.ts", "line": 11 }, "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMetricFactory.ts", "line": 5 }, "name": "SnsTopicMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMetricFactory.ts", "line": 6 }, "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" } } ], "protected": true, "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" } } ], "protected": true, "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" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 153 }, "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-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", "protected": true, "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", "protected": true, "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", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 63 }, "name": "messagesFailedMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 62 }, "name": "messageSizeMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 61 }, "name": "outgoingMessagesMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 53 }, "name": "title", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sns/SnsTopicMonitoring.ts", "line": 56 }, "name": "topicAlarmFactory", "protected": true, "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, "protected": 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.SqsQueueMetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SqsQueueMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 13 }, "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": 9 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 44 }, "name": "metricApproximateAgeOfOldestMessageInSeconds", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 18 }, "name": "metricApproximateVisibleMessageCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 52 }, "name": "metricAverageMessageSizeInBytes", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 70 }, "name": "metricConsumptionRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 35 }, "name": "metricDeletedMessageCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 26 }, "name": "metricIncomingMessageCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 60 }, "name": "metricProductionRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 82 }, "name": "metricTimeToDrain", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "SqsQueueMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 10 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 11 }, "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 5 }, "name": "SqsQueueMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMetricFactory.ts", "line": 6 }, "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" } } ], "protected": true, "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" } } ], "protected": true, "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" } } ], "protected": true, "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" } } ], "protected": true, "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" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 230 }, "name": "createTitleWidget", "protected": true, "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", "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/SqsQueueMonitoring.ts", "line": 80 }, "name": "consumptionRateMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 70 }, "name": "countAnnotations", "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/SqsQueueMonitoring.ts", "line": 76 }, "name": "deletedMessagesMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 75 }, "name": "incomingMessagesMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 78 }, "name": "messageSizeMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 77 }, "name": "oldestMessageAgeMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 79 }, "name": "productionRateMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 69 }, "name": "queueAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.QueueAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 72 }, "name": "timeToDrainAnnotations", "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/SqsQueueMonitoring.ts", "line": 81 }, "name": "timeToDrainMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 66 }, "name": "title", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 74 }, "name": "visibleMessagesMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-sqs/SqsQueueMonitoring.ts", "line": 67 }, "name": "queueUrl", "optional": true, "protected": 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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.StepFunctionActivityMetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StepFunctionActivityMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 25 }, "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": 20 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 135 }, "name": "metricActivitiesFailed", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 146 }, "name": "metricActivitiesFailedRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 156 }, "name": "metricActivitiesHeartbeatTimedOut", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 167 }, "name": "metricActivitiesScheduled", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 178 }, "name": "metricActivitiesStarted", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 189 }, "name": "metricActivitiesSucceeded", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 200 }, "name": "metricActivitiesTimedOut", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 58 }, "name": "metricActivityRunTimeP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 47 }, "name": "metricActivityRunTimeP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 36 }, "name": "metricActivityRunTimeP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 91 }, "name": "metricActivityScheduleTimeP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 80 }, "name": "metricActivityScheduleTimeP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 69 }, "name": "metricActivityScheduleTimeP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 124 }, "name": "metricActivityTimeP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 113 }, "name": "metricActivityTimeP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 102 }, "name": "metricActivityTimeP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "StepFunctionActivityMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 23 }, "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": 21 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 22 }, "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 12 }, "name": "StepFunctionActivityMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMetricFactory.ts", "line": 13 }, "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": 17 }, "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", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 56 }, "name": "durationAnnotations", "protected": true, "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", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 57 }, "name": "errorCountAnnotations", "protected": true, "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", "protected": true, "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", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 67 }, "name": "failedActivitiesRateMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 68 }, "name": "heartbeatTimedOutActivitiesMetrics", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 60 }, "name": "p50DurationMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 61 }, "name": "p90DurationMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 62 }, "name": "p99DurationMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 63 }, "name": "scheduledActivitiesMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 64 }, "name": "startedActivitiesMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 65 }, "name": "succeededActivitiesMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 69 }, "name": "timedOutActivitiesMetrics", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionActivityMonitoring.ts", "line": 51 }, "name": "title", "protected": true, "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.StepFunctionLambdaIntegrationMetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StepFunctionLambdaIntegrationMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 25 }, "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": 20 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 58 }, "name": "metricFunctionRunTimeP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 47 }, "name": "metricFunctionRunTimeP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 36 }, "name": "metricFunctionRunTimeP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 91 }, "name": "metricFunctionScheduleTimeP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 80 }, "name": "metricFunctionScheduleTimeP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 69 }, "name": "metricFunctionScheduleTimeP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 135 }, "name": "metricFunctionsFailed", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 146 }, "name": "metricFunctionsFailedRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 156 }, "name": "metricFunctionsScheduled", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 167 }, "name": "metricFunctionsStarted", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 178 }, "name": "metricFunctionsSucceeded", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 189 }, "name": "metricFunctionsTimedOut", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 124 }, "name": "metricFunctionTimeP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 113 }, "name": "metricFunctionTimeP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 102 }, "name": "metricFunctionTimeP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "StepFunctionLambdaIntegrationMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 23 }, "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": 21 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 22 }, "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 12 }, "name": "StepFunctionLambdaIntegrationMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMetricFactory.ts", "line": 13 }, "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": 17 }, "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": 68 }, "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": 47 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Returns widgets to be placed on the summary dashboard." }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 178 }, "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": 217 }, "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": 52 }, "name": "durationAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 54 }, "name": "durationAnnotations", "protected": true, "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": 51 }, "name": "errorAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 55 }, "name": "errorCountAnnotations", "protected": true, "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": 56 }, "name": "errorRateAnnotations", "protected": true, "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": 65 }, "name": "failedFunctionRateMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 64 }, "name": "failedFunctionsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 58 }, "name": "p50DurationMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 59 }, "name": "p90DurationMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 60 }, "name": "p99DurationMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 61 }, "name": "scheduledFunctionsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 62 }, "name": "startedFunctionsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 63 }, "name": "succeededFunctionsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 66 }, "name": "timedOutFunctionsMetrics", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 48 }, "name": "title", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.ts", "line": 49 }, "name": "functionUrl", "optional": true, "protected": 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": 35 }, "name": "StepFunctionLambdaIntegrationMonitoringProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionLambdaIntegrationMonitoring.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/StepFunctionLambdaIntegrationMonitoring.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/StepFunctionLambdaIntegrationMonitoring.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/StepFunctionLambdaIntegrationMonitoring.ts", "line": 42 }, "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": 43 }, "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": 44 }, "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", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StepFunctionMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 25 }, "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": 20 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 112 }, "name": "metricExecutionsAborted", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 69 }, "name": "metricExecutionsFailed", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 80 }, "name": "metricExecutionsFailedRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 123 }, "name": "metricExecutionsStarted", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 134 }, "name": "metricExecutionsSucceeded", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 90 }, "name": "metricExecutionsTimedOut", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 101 }, "name": "metricExecutionThrottled", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 58 }, "name": "metricExecutionTimeP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 47 }, "name": "metricExecutionTimeP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 36 }, "name": "metricExecutionTimeP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "StepFunctionMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 23 }, "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": 21 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 22 }, "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 12 }, "name": "StepFunctionMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMetricFactory.ts", "line": 13 }, "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": 17 }, "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", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 68 }, "name": "durationAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 70 }, "name": "durationAnnotations", "protected": true, "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", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 71 }, "name": "errorCountAnnotations", "protected": true, "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", "protected": true, "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", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 79 }, "name": "failedExecutionsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 74 }, "name": "p50DurationMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 75 }, "name": "p90DurationMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 76 }, "name": "p99DurationMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 77 }, "name": "startedExecutionsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 78 }, "name": "succeededExecutionsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 69 }, "name": "taskHealthAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.TaskHealthAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 82 }, "name": "throttledExecutionsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 83 }, "name": "timedOutExecutionsMetrics", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 64 }, "name": "title", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionMonitoring.ts", "line": 65 }, "name": "stateMachineUrl", "optional": true, "protected": 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", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.StepFunctionServiceIntegrationMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 24 }, "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": 19 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 57 }, "name": "metricServiceIntegrationRunTimeP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 46 }, "name": "metricServiceIntegrationRunTimeP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 35 }, "name": "metricServiceIntegrationRunTimeP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 90 }, "name": "metricServiceIntegrationScheduleTimeP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 79 }, "name": "metricServiceIntegrationScheduleTimeP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 68 }, "name": "metricServiceIntegrationScheduleTimeP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 134 }, "name": "metricServiceIntegrationsFailed", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 145 }, "name": "metricServiceIntegrationsFailedRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 155 }, "name": "metricServiceIntegrationsScheduled", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 166 }, "name": "metricServiceIntegrationsStarted", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 177 }, "name": "metricServiceIntegrationsSucceeded", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 188 }, "name": "metricServiceIntegrationsTimedOut", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 123 }, "name": "metricServiceIntegrationTimeP50InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 112 }, "name": "metricServiceIntegrationTimeP90InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 101 }, "name": "metricServiceIntegrationTimeP99InMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "StepFunctionServiceIntegrationMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 22 }, "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": 20 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 21 }, "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 11 }, "name": "StepFunctionServiceIntegrationMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 12 }, "name": "serviceIntegrationResourceArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- average", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMetricFactory.ts", "line": 16 }, "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", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 62 }, "name": "durationAnnotations", "protected": true, "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", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 63 }, "name": "errorCountAnnotations", "protected": true, "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", "protected": true, "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", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 72 }, "name": "failedServiceIntegrationsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 66 }, "name": "p50DurationMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 67 }, "name": "p90DurationMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 68 }, "name": "p99DurationMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 69 }, "name": "scheduledServiceIntegrationsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 70 }, "name": "startedServiceIntegrationsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 71 }, "name": "succeededServiceIntegrationsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 74 }, "name": "timedOutServiceIntegrationsMetrics", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-step-functions/StepFunctionServiceIntegrationMonitoring.ts", "line": 57 }, "name": "title", "protected": true, "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": 7 }, "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.SyntheticsCanaryMetricFactory": { "assembly": "cdk-monitoring-constructs", "docs": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.SyntheticsCanaryMetricFactory", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 29 }, "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": 23 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 60 }, "name": "metric4xxErrorCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 71 }, "name": "metric4xxErrorRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 81 }, "name": "metric5xxFaultCount", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 92 }, "name": "metric5xxFaultRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 42 }, "name": "metricLatencyAverageInMillis", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 51 }, "name": "metricSuccessInPercent", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "SyntheticsCanaryMetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 24 }, "name": "canary", "protected": true, "type": { "fqn": "@aws-cdk/aws-synthetics-alpha.Canary" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 27 }, "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": 25 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 26 }, "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 11 }, "name": "SyntheticsCanaryMetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "CloudWatch Canary to monitor." }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMetricFactory.ts", "line": 15 }, "name": "canary", "type": { "fqn": "@aws-cdk/aws-synthetics-alpha.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": 20 }, "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" } } ], "protected": true, "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" } } ], "protected": true, "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" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.GraphWidget" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 173 }, "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-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", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 57 }, "name": "errorAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.ErrorAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 59 }, "name": "errorCountAnnotations", "protected": true, "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", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 60 }, "name": "errorRateAnnotations", "protected": true, "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", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 65 }, "name": "faultCountMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 66 }, "name": "faultRateMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 54 }, "name": "humanReadableName", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 56 }, "name": "latencyAlarmFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.LatencyAlarmFactory" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.ts", "line": 58 }, "name": "latencyAnnotations", "protected": true, "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 32 }, "parameters": [ { "name": "alarmFactory", "type": { "fqn": "cdk-monitoring-constructs.AlarmFactory" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 29 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 36 }, "name": "addMaxCpuUsagePercentAlarm", "parameters": [ { "name": "percentMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 130 }, "name": "addMaxDiskUsagePercentAlarm", "parameters": [ { "name": "percentMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 168 }, "name": "addMaxFileDescriptorPercentAlarm", "parameters": [ { "name": "percentMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 149 }, "name": "addMaxHeapMemoryAfterGCUsagePercentAlarm", "parameters": [ { "name": "percentMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 55 }, "name": "addMaxMasterCpuUsagePercentAlarm", "parameters": [ { "name": "percentMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 111 }, "name": "addMaxMasterMemoryUsagePercentAlarm", "parameters": [ { "name": "percentMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 74 }, "name": "addMaxMemoryUsagePercentAlarm", "parameters": [ { "name": "percentMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 187 }, "name": "addMaxThreadCountUsageAlarm", "parameters": [ { "name": "percentMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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": 87 }, "name": "addMemoryUsagePercentAlarm", "parameters": [ { "name": "percentMetric", "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "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" } } } ], "name": "UsageAlarmFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 30 }, "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": { "stability": "experimental" }, "fqn": "cdk-monitoring-constructs.UsageCountThreshold", "interfaces": [ "cdk-monitoring-constructs.CustomAlarmThreshold" ], "kind": "interface", "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 25 }, "name": "UsageCountThreshold", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/common/monitoring/alarms/UsageAlarmFactory.ts", "line": 26 }, "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.WafV2MetricFactory": { "assembly": "cdk-monitoring-constructs", "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": 20 }, "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": 16 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2MetricFactory.ts", "line": 28 }, "name": "metricAllowedRequests", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2MetricFactory.ts", "line": 39 }, "name": "metricBlockedRequests", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2MetricFactory.ts", "line": 50 }, "name": "metricBlockedRequestsRate", "returns": { "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } } } ], "name": "WafV2MetricFactory", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2MetricFactory.ts", "line": 18 }, "name": "dimensions", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2MetricFactory.ts", "line": 17 }, "name": "metricFactory", "protected": true, "type": { "fqn": "cdk-monitoring-constructs.MetricFactory" } } ], "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", "kind": "interface", "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2MetricFactory.ts", "line": 8 }, "name": "WafV2MetricFactoryProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2MetricFactory.ts", "line": 10 }, "name": "acl", "type": { "fqn": "aws-cdk-lib.aws_wafv2.CfnWebACL" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2MetricFactory.ts", "line": 9 }, "name": "region", "optional": true, "type": { "primitive": "string" } } ], "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": 40 }, "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": 33 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 90 }, "name": "createAllowedRequestsWidget", "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-wafv2/WafV2Monitoring.ts", "line": 110 }, "name": "createBlockedRequestsRateWidget", "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-wafv2/WafV2Monitoring.ts", "line": 100 }, "name": "createBlockedRequestsWidget", "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-wafv2/WafV2Monitoring.ts", "line": 83 }, "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-wafv2/WafV2Monitoring.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-wafv2/WafV2Monitoring.ts", "line": 71 }, "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": 36 }, "name": "allowedRequestsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 37 }, "name": "blockedRequestsMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 38 }, "name": "blockedRequestsRateMetric", "protected": true, "type": { "union": { "types": [ { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" }, { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpression" } ] } } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "lib/monitoring/aws-wafv2/WafV2Monitoring.ts", "line": 34 }, "name": "humanReadableName", "protected": true, "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": 22 }, "name": "WafV2MonitoringOptions", "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": 24 }, "name": "WafV2MonitoringProps", "symbolId": "lib/monitoring/aws-wafv2/WafV2Monitoring:WafV2MonitoringProps" }, "cdk-monitoring-constructs.XaxrMathExpression": { "assembly": "cdk-monitoring-constructs", "docs": { "see": "https://github.com/aws/aws-cdk/issues/9039", "stability": "experimental", "summary": "Custom wrapper class for MathExpression that supports account and region specification." }, "fqn": "cdk-monitoring-constructs.XaxrMathExpression", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/metric/XaxrMathExpression.ts", "line": 39 }, "parameters": [ { "name": "props", "type": { "fqn": "cdk-monitoring-constructs.XaxrMathExpressionProps" } } ] }, "interfaces": [ "aws-cdk-lib.aws_cloudwatch.IMetric" ], "kind": "class", "locationInModule": { "filename": "lib/common/metric/XaxrMathExpression.ts", "line": 35 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Inspect the details of the metric object." }, "locationInModule": { "filename": "lib/common/metric/XaxrMathExpression.ts", "line": 51 }, "name": "toMetricConfig", "overrides": "aws-cdk-lib.aws_cloudwatch.IMetric", "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MetricConfig" } } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/common/metric/XaxrMathExpression.ts", "line": 44 }, "name": "with", "parameters": [ { "name": "options", "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MathExpressionOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.IMetric" } } } ], "name": "XaxrMathExpression", "symbolId": "lib/common/metric/XaxrMathExpression:XaxrMathExpression" }, "cdk-monitoring-constructs.XaxrMathExpressionProps": { "assembly": "cdk-monitoring-constructs", "datatype": true, "docs": { "see": "https://github.com/aws/aws-cdk/issues/9039", "stability": "experimental", "summary": "Custom wrapper class for MathExpressionProps that supports account and region customization." }, "fqn": "cdk-monitoring-constructs.XaxrMathExpressionProps", "interfaces": [ "aws-cdk-lib.aws_cloudwatch.MathExpressionProps" ], "kind": "interface", "locationInModule": { "filename": "lib/common/metric/XaxrMathExpression.ts", "line": 13 }, "name": "XaxrMathExpressionProps", "properties": [ { "abstract": true, "docs": { "default": "- Deployment account.", "stability": "experimental", "summary": "(experimental) Account which this metric comes from." }, "immutable": true, "locationInModule": { "filename": "lib/common/metric/XaxrMathExpression.ts", "line": 20 }, "name": "account", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Deployment region.", "stability": "experimental", "summary": "(experimental) Region which this metric comes from." }, "immutable": true, "locationInModule": { "filename": "lib/common/metric/XaxrMathExpression.ts", "line": 28 }, "name": "region", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/common/metric/XaxrMathExpression:XaxrMathExpressionProps" } }, "version": "1.21.0", "fingerprint": "Vj0ap+1RAaamr4bPxJZGS4gif5rLt1Z2kLskvxg8HqY=" }