{
"author": {
"email": "webmaster+cdk@renovo1.com",
"name": "Renovo Solutions",
"roles": [
"author"
]
},
"dependencies": {
"aws-cdk-lib": "^2.205.0",
"constructs": "^10.0.5"
},
"dependencyClosure": {
"@aws-cdk/asset-awscli-v1": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.Asset.AwsCliV1",
"packageId": "Amazon.CDK.Asset.AwsCliV1"
},
"go": {
"moduleName": "github.com/cdklabs/awscdk-asset-awscli-go",
"packageName": "awscliv1"
},
"java": {
"maven": {
"artifactId": "cdk-asset-awscli-v1",
"groupId": "software.amazon.awscdk"
},
"package": "software.amazon.awscdk.cdk.asset.awscli.v1"
},
"js": {
"npm": "@aws-cdk/asset-awscli-v1"
},
"python": {
"distName": "aws-cdk.asset-awscli-v1",
"module": "aws_cdk.asset_awscli_v1"
}
}
},
"@aws-cdk/asset-node-proxy-agent-v6": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.Asset.NodeProxyAgentV6",
"packageId": "Amazon.CDK.Asset.NodeProxyAgentV6"
},
"go": {
"moduleName": "github.com/cdklabs/awscdk-asset-node-proxy-agent-go",
"packageName": "nodeproxyagentv6"
},
"java": {
"maven": {
"artifactId": "cdk-asset-node-proxy-agent-v6",
"groupId": "software.amazon.awscdk"
},
"package": "software.amazon.awscdk.cdk.asset.node.proxy.agent.v6"
},
"js": {
"npm": "@aws-cdk/asset-node-proxy-agent-v6"
},
"python": {
"distName": "aws-cdk.asset-node-proxy-agent-v6",
"module": "aws_cdk.asset_node_proxy_agent_v6"
}
}
},
"@aws-cdk/cloud-assembly-schema": {
"targets": {
"dotnet": {
"iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/main/logo/default-256-dark.png",
"namespace": "Amazon.CDK.CloudAssembly.Schema",
"packageId": "Amazon.CDK.CloudAssembly.Schema"
},
"go": {
"moduleName": "github.com/cdklabs/cloud-assembly-schema-go"
},
"java": {
"maven": {
"artifactId": "cdk-cloud-assembly-schema",
"groupId": "software.amazon.awscdk"
},
"package": "software.amazon.awscdk.cloudassembly.schema"
},
"js": {
"npm": "@aws-cdk/cloud-assembly-schema"
},
"python": {
"classifiers": [
"Framework :: AWS CDK",
"Framework :: AWS CDK :: 2"
],
"distName": "aws-cdk.cloud-assembly-schema",
"module": "aws_cdk.cloud_assembly_schema"
}
}
},
"aws-cdk-lib": {
"submodules": {
"aws-cdk-lib.alexa_ask": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.Alexa.Ask"
},
"java": {
"package": "software.amazon.awscdk.alexa.ask"
},
"python": {
"module": "aws_cdk.alexa_ask"
}
}
},
"aws-cdk-lib.assertions": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.Assertions"
},
"java": {
"package": "software.amazon.awscdk.assertions"
},
"python": {
"module": "aws_cdk.assertions"
}
}
},
"aws-cdk-lib.assets": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.Assets"
},
"java": {
"package": "software.amazon.awscdk.assets"
},
"python": {
"module": "aws_cdk.assets"
}
}
},
"aws-cdk-lib.aws_accessanalyzer": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.AccessAnalyzer"
},
"java": {
"package": "software.amazon.awscdk.services.accessanalyzer"
},
"python": {
"module": "aws_cdk.aws_accessanalyzer"
}
}
},
"aws-cdk-lib.aws_acmpca": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.ACMPCA"
},
"java": {
"package": "software.amazon.awscdk.services.acmpca"
},
"python": {
"module": "aws_cdk.aws_acmpca"
}
}
},
"aws-cdk-lib.aws_aiops": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.AIOps"
},
"java": {
"package": "software.amazon.awscdk.services.aiops"
},
"python": {
"module": "aws_cdk.aws_aiops"
}
}
},
"aws-cdk-lib.aws_amazonmq": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.AmazonMQ"
},
"java": {
"package": "software.amazon.awscdk.services.amazonmq"
},
"python": {
"module": "aws_cdk.aws_amazonmq"
}
}
},
"aws-cdk-lib.aws_amplify": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Amplify"
},
"java": {
"package": "software.amazon.awscdk.services.amplify"
},
"python": {
"module": "aws_cdk.aws_amplify"
}
}
},
"aws-cdk-lib.aws_amplifyuibuilder": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.AmplifyUIBuilder"
},
"java": {
"package": "software.amazon.awscdk.services.amplifyuibuilder"
},
"python": {
"module": "aws_cdk.aws_amplifyuibuilder"
}
}
},
"aws-cdk-lib.aws_apigateway": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.APIGateway"
},
"java": {
"package": "software.amazon.awscdk.services.apigateway"
},
"python": {
"module": "aws_cdk.aws_apigateway"
}
}
},
"aws-cdk-lib.aws_apigatewayv2": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Apigatewayv2"
},
"java": {
"package": "software.amazon.awscdk.services.apigatewayv2"
},
"python": {
"module": "aws_cdk.aws_apigatewayv2"
}
}
},
"aws-cdk-lib.aws_apigatewayv2_authorizers": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AwsApigatewayv2Authorizers"
},
"java": {
"package": "software.amazon.awscdk.aws_apigatewayv2_authorizers"
},
"python": {
"module": "aws_cdk.aws_apigatewayv2_authorizers"
}
}
},
"aws-cdk-lib.aws_apigatewayv2_integrations": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AwsApigatewayv2Integrations"
},
"java": {
"package": "software.amazon.awscdk.aws_apigatewayv2_integrations"
},
"python": {
"module": "aws_cdk.aws_apigatewayv2_integrations"
}
}
},
"aws-cdk-lib.aws_appconfig": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.AppConfig"
},
"java": {
"package": "software.amazon.awscdk.services.appconfig"
},
"python": {
"module": "aws_cdk.aws_appconfig"
}
}
},
"aws-cdk-lib.aws_appflow": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.AppFlow"
},
"java": {
"package": "software.amazon.awscdk.services.appflow"
},
"python": {
"module": "aws_cdk.aws_appflow"
}
}
},
"aws-cdk-lib.aws_appintegrations": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.AppIntegrations"
},
"java": {
"package": "software.amazon.awscdk.services.appintegrations"
},
"python": {
"module": "aws_cdk.aws_appintegrations"
}
}
},
"aws-cdk-lib.aws_applicationautoscaling": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.ApplicationAutoScaling"
},
"java": {
"package": "software.amazon.awscdk.services.applicationautoscaling"
},
"python": {
"module": "aws_cdk.aws_applicationautoscaling"
}
}
},
"aws-cdk-lib.aws_applicationinsights": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.ApplicationInsights"
},
"java": {
"package": "software.amazon.awscdk.services.applicationinsights"
},
"python": {
"module": "aws_cdk.aws_applicationinsights"
}
}
},
"aws-cdk-lib.aws_applicationsignals": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.ApplicationSignals"
},
"java": {
"package": "software.amazon.awscdk.services.applicationsignals"
},
"python": {
"module": "aws_cdk.aws_applicationsignals"
}
}
},
"aws-cdk-lib.aws_appmesh": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.AppMesh"
},
"java": {
"package": "software.amazon.awscdk.services.appmesh"
},
"python": {
"module": "aws_cdk.aws_appmesh"
}
}
},
"aws-cdk-lib.aws_apprunner": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.AppRunner"
},
"java": {
"package": "software.amazon.awscdk.services.apprunner"
},
"python": {
"module": "aws_cdk.aws_apprunner"
}
}
},
"aws-cdk-lib.aws_appstream": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.AppStream"
},
"java": {
"package": "software.amazon.awscdk.services.appstream"
},
"python": {
"module": "aws_cdk.aws_appstream"
}
}
},
"aws-cdk-lib.aws_appsync": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.AppSync"
},
"java": {
"package": "software.amazon.awscdk.services.appsync"
},
"python": {
"module": "aws_cdk.aws_appsync"
}
}
},
"aws-cdk-lib.aws_apptest": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.AppTest"
},
"java": {
"package": "software.amazon.awscdk.services.apptest"
},
"python": {
"module": "aws_cdk.aws_apptest"
}
}
},
"aws-cdk-lib.aws_aps": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.APS"
},
"java": {
"package": "software.amazon.awscdk.services.aps"
},
"python": {
"module": "aws_cdk.aws_aps"
}
}
},
"aws-cdk-lib.aws_arczonalshift": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.ARCZonalShift"
},
"java": {
"package": "software.amazon.awscdk.services.arczonalshift"
},
"python": {
"module": "aws_cdk.aws_arczonalshift"
}
}
},
"aws-cdk-lib.aws_athena": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Athena"
},
"java": {
"package": "software.amazon.awscdk.services.athena"
},
"python": {
"module": "aws_cdk.aws_athena"
}
}
},
"aws-cdk-lib.aws_auditmanager": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.AuditManager"
},
"java": {
"package": "software.amazon.awscdk.services.auditmanager"
},
"python": {
"module": "aws_cdk.aws_auditmanager"
}
}
},
"aws-cdk-lib.aws_autoscaling": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.AutoScaling"
},
"java": {
"package": "software.amazon.awscdk.services.autoscaling"
},
"python": {
"module": "aws_cdk.aws_autoscaling"
}
}
},
"aws-cdk-lib.aws_autoscaling_common": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.AutoScaling.Common"
},
"java": {
"package": "software.amazon.awscdk.services.autoscaling.common"
},
"python": {
"module": "aws_cdk.aws_autoscaling_common"
}
}
},
"aws-cdk-lib.aws_autoscaling_hooktargets": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.AutoScaling.HookTargets"
},
"java": {
"package": "software.amazon.awscdk.services.autoscaling.hooktargets"
},
"python": {
"module": "aws_cdk.aws_autoscaling_hooktargets"
}
}
},
"aws-cdk-lib.aws_autoscalingplans": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.AutoScalingPlans"
},
"java": {
"package": "software.amazon.awscdk.services.autoscalingplans"
},
"python": {
"module": "aws_cdk.aws_autoscalingplans"
}
}
},
"aws-cdk-lib.aws_b2bi": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.B2BI"
},
"java": {
"package": "software.amazon.awscdk.services.b2bi"
},
"python": {
"module": "aws_cdk.aws_b2bi"
}
}
},
"aws-cdk-lib.aws_backup": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Backup"
},
"java": {
"package": "software.amazon.awscdk.services.backup"
},
"python": {
"module": "aws_cdk.aws_backup"
}
}
},
"aws-cdk-lib.aws_backupgateway": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.BackupGateway"
},
"java": {
"package": "software.amazon.awscdk.services.backupgateway"
},
"python": {
"module": "aws_cdk.aws_backupgateway"
}
}
},
"aws-cdk-lib.aws_batch": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Batch"
},
"java": {
"package": "software.amazon.awscdk.services.batch"
},
"python": {
"module": "aws_cdk.aws_batch"
}
}
},
"aws-cdk-lib.aws_bcmdataexports": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.BCMDataExports"
},
"java": {
"package": "software.amazon.awscdk.services.bcmdataexports"
},
"python": {
"module": "aws_cdk.aws_bcmdataexports"
}
}
},
"aws-cdk-lib.aws_bedrock": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.Bedrock"
},
"java": {
"package": "software.amazon.awscdk.services.bedrock"
},
"python": {
"module": "aws_cdk.aws_bedrock"
}
}
},
"aws-cdk-lib.aws_billingconductor": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.BillingConductor"
},
"java": {
"package": "software.amazon.awscdk.services.billingconductor"
},
"python": {
"module": "aws_cdk.aws_billingconductor"
}
}
},
"aws-cdk-lib.aws_budgets": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Budgets"
},
"java": {
"package": "software.amazon.awscdk.services.budgets"
},
"python": {
"module": "aws_cdk.aws_budgets"
}
}
},
"aws-cdk-lib.aws_cassandra": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Cassandra"
},
"java": {
"package": "software.amazon.awscdk.services.cassandra"
},
"python": {
"module": "aws_cdk.aws_cassandra"
}
}
},
"aws-cdk-lib.aws_ce": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.CE"
},
"java": {
"package": "software.amazon.awscdk.services.ce"
},
"python": {
"module": "aws_cdk.aws_ce"
}
}
},
"aws-cdk-lib.aws_certificatemanager": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.CertificateManager"
},
"java": {
"package": "software.amazon.awscdk.services.certificatemanager"
},
"python": {
"module": "aws_cdk.aws_certificatemanager"
}
}
},
"aws-cdk-lib.aws_chatbot": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Chatbot"
},
"java": {
"package": "software.amazon.awscdk.services.chatbot"
},
"python": {
"module": "aws_cdk.aws_chatbot"
}
}
},
"aws-cdk-lib.aws_cleanrooms": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.CleanRooms"
},
"java": {
"package": "software.amazon.awscdk.services.cleanrooms"
},
"python": {
"module": "aws_cdk.aws_cleanrooms"
}
}
},
"aws-cdk-lib.aws_cleanroomsml": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.CleanRoomsML"
},
"java": {
"package": "software.amazon.awscdk.services.cleanroomsml"
},
"python": {
"module": "aws_cdk.aws_cleanroomsml"
}
}
},
"aws-cdk-lib.aws_cloud9": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Cloud9"
},
"java": {
"package": "software.amazon.awscdk.services.cloud9"
},
"python": {
"module": "aws_cdk.aws_cloud9"
}
}
},
"aws-cdk-lib.aws_cloudformation": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.CloudFormation"
},
"java": {
"package": "software.amazon.awscdk.services.cloudformation"
},
"python": {
"module": "aws_cdk.aws_cloudformation"
}
}
},
"aws-cdk-lib.aws_cloudfront": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.CloudFront"
},
"java": {
"package": "software.amazon.awscdk.services.cloudfront"
},
"python": {
"module": "aws_cdk.aws_cloudfront"
}
}
},
"aws-cdk-lib.aws_cloudfront.experimental": {},
"aws-cdk-lib.aws_cloudfront_origins": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.CloudFront.Origins"
},
"java": {
"package": "software.amazon.awscdk.services.cloudfront.origins"
},
"python": {
"module": "aws_cdk.aws_cloudfront_origins"
}
}
},
"aws-cdk-lib.aws_cloudtrail": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.CloudTrail"
},
"java": {
"package": "software.amazon.awscdk.services.cloudtrail"
},
"python": {
"module": "aws_cdk.aws_cloudtrail"
}
}
},
"aws-cdk-lib.aws_cloudwatch": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.CloudWatch"
},
"java": {
"package": "software.amazon.awscdk.services.cloudwatch"
},
"python": {
"module": "aws_cdk.aws_cloudwatch"
}
}
},
"aws-cdk-lib.aws_cloudwatch_actions": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.CloudWatch.Actions"
},
"java": {
"package": "software.amazon.awscdk.services.cloudwatch.actions"
},
"python": {
"module": "aws_cdk.aws_cloudwatch_actions"
}
}
},
"aws-cdk-lib.aws_codeartifact": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.CodeArtifact"
},
"java": {
"package": "software.amazon.awscdk.services.codeartifact"
},
"python": {
"module": "aws_cdk.aws_codeartifact"
}
}
},
"aws-cdk-lib.aws_codebuild": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.CodeBuild"
},
"java": {
"package": "software.amazon.awscdk.services.codebuild"
},
"python": {
"module": "aws_cdk.aws_codebuild"
}
}
},
"aws-cdk-lib.aws_codecommit": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.CodeCommit"
},
"java": {
"package": "software.amazon.awscdk.services.codecommit"
},
"python": {
"module": "aws_cdk.aws_codecommit"
}
}
},
"aws-cdk-lib.aws_codeconnections": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.CodeConnections"
},
"java": {
"package": "software.amazon.awscdk.services.codeconnections"
},
"python": {
"module": "aws_cdk.aws_codeconnections"
}
}
},
"aws-cdk-lib.aws_codedeploy": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.CodeDeploy"
},
"java": {
"package": "software.amazon.awscdk.services.codedeploy"
},
"python": {
"module": "aws_cdk.aws_codedeploy"
}
}
},
"aws-cdk-lib.aws_codeguruprofiler": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.CodeGuruProfiler"
},
"java": {
"package": "software.amazon.awscdk.services.codeguruprofiler"
},
"python": {
"module": "aws_cdk.aws_codeguruprofiler"
}
}
},
"aws-cdk-lib.aws_codegurureviewer": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.CodeGuruReviewer"
},
"java": {
"package": "software.amazon.awscdk.services.codegurureviewer"
},
"python": {
"module": "aws_cdk.aws_codegurureviewer"
}
}
},
"aws-cdk-lib.aws_codepipeline": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.CodePipeline"
},
"java": {
"package": "software.amazon.awscdk.services.codepipeline"
},
"python": {
"module": "aws_cdk.aws_codepipeline"
}
}
},
"aws-cdk-lib.aws_codepipeline_actions": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.CodePipeline.Actions"
},
"java": {
"package": "software.amazon.awscdk.services.codepipeline.actions"
},
"python": {
"module": "aws_cdk.aws_codepipeline_actions"
}
}
},
"aws-cdk-lib.aws_codestar": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Codestar"
},
"java": {
"package": "software.amazon.awscdk.services.codestar"
},
"python": {
"module": "aws_cdk.aws_codestar"
}
}
},
"aws-cdk-lib.aws_codestarconnections": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.CodeStarConnections"
},
"java": {
"package": "software.amazon.awscdk.services.codestarconnections"
},
"python": {
"module": "aws_cdk.aws_codestarconnections"
}
}
},
"aws-cdk-lib.aws_codestarnotifications": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.CodeStarNotifications"
},
"java": {
"package": "software.amazon.awscdk.services.codestarnotifications"
},
"python": {
"module": "aws_cdk.aws_codestarnotifications"
}
}
},
"aws-cdk-lib.aws_cognito": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Cognito"
},
"java": {
"package": "software.amazon.awscdk.services.cognito"
},
"python": {
"module": "aws_cdk.aws_cognito"
}
}
},
"aws-cdk-lib.aws_cognito_identitypool": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Cognito.Identitypool"
},
"java": {
"package": "software.amazon.awscdk.services.cognito.identitypool"
},
"python": {
"module": "aws_cdk.aws_cognito_identitypool"
}
}
},
"aws-cdk-lib.aws_comprehend": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Comprehend"
},
"java": {
"package": "software.amazon.awscdk.services.comprehend"
},
"python": {
"module": "aws_cdk.aws_comprehend"
}
}
},
"aws-cdk-lib.aws_config": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Config"
},
"java": {
"package": "software.amazon.awscdk.services.config"
},
"python": {
"module": "aws_cdk.aws_config"
}
}
},
"aws-cdk-lib.aws_connect": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Connect"
},
"java": {
"package": "software.amazon.awscdk.services.connect"
},
"python": {
"module": "aws_cdk.aws_connect"
}
}
},
"aws-cdk-lib.aws_connectcampaigns": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.ConnectCampaigns"
},
"java": {
"package": "software.amazon.awscdk.services.connectcampaigns"
},
"python": {
"module": "aws_cdk.aws_connectcampaigns"
}
}
},
"aws-cdk-lib.aws_connectcampaignsv2": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.ConnectCampaignsV2"
},
"java": {
"package": "software.amazon.awscdk.services.connectcampaignsv2"
},
"python": {
"module": "aws_cdk.aws_connectcampaignsv2"
}
}
},
"aws-cdk-lib.aws_controltower": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.ControlTower"
},
"java": {
"package": "software.amazon.awscdk.services.controltower"
},
"python": {
"module": "aws_cdk.aws_controltower"
}
}
},
"aws-cdk-lib.aws_cur": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.CUR"
},
"java": {
"package": "software.amazon.awscdk.services.cur"
},
"python": {
"module": "aws_cdk.aws_cur"
}
}
},
"aws-cdk-lib.aws_customerprofiles": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.CustomerProfiles"
},
"java": {
"package": "software.amazon.awscdk.services.customerprofiles"
},
"python": {
"module": "aws_cdk.aws_customerprofiles"
}
}
},
"aws-cdk-lib.aws_databrew": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.DataBrew"
},
"java": {
"package": "software.amazon.awscdk.services.databrew"
},
"python": {
"module": "aws_cdk.aws_databrew"
}
}
},
"aws-cdk-lib.aws_datapipeline": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.DataPipeline"
},
"java": {
"package": "software.amazon.awscdk.services.datapipeline"
},
"python": {
"module": "aws_cdk.aws_datapipeline"
}
}
},
"aws-cdk-lib.aws_datasync": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.DataSync"
},
"java": {
"package": "software.amazon.awscdk.services.datasync"
},
"python": {
"module": "aws_cdk.aws_datasync"
}
}
},
"aws-cdk-lib.aws_datazone": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.DataZone"
},
"java": {
"package": "software.amazon.awscdk.services.datazone"
},
"python": {
"module": "aws_cdk.aws_datazone"
}
}
},
"aws-cdk-lib.aws_dax": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.DAX"
},
"java": {
"package": "software.amazon.awscdk.services.dax"
},
"python": {
"module": "aws_cdk.aws_dax"
}
}
},
"aws-cdk-lib.aws_deadline": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.Deadline"
},
"java": {
"package": "software.amazon.awscdk.services.deadline"
},
"python": {
"module": "aws_cdk.aws_deadline"
}
}
},
"aws-cdk-lib.aws_detective": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Detective"
},
"java": {
"package": "software.amazon.awscdk.services.detective"
},
"python": {
"module": "aws_cdk.aws_detective"
}
}
},
"aws-cdk-lib.aws_devicefarm": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.DeviceFarm"
},
"java": {
"package": "software.amazon.awscdk.services.devicefarm"
},
"python": {
"module": "aws_cdk.aws_devicefarm"
}
}
},
"aws-cdk-lib.aws_devopsguru": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.DevOpsGuru"
},
"java": {
"package": "software.amazon.awscdk.services.devopsguru"
},
"python": {
"module": "aws_cdk.aws_devopsguru"
}
}
},
"aws-cdk-lib.aws_directoryservice": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.DirectoryService"
},
"java": {
"package": "software.amazon.awscdk.services.directoryservice"
},
"python": {
"module": "aws_cdk.aws_directoryservice"
}
}
},
"aws-cdk-lib.aws_dlm": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.DLM"
},
"java": {
"package": "software.amazon.awscdk.services.dlm"
},
"python": {
"module": "aws_cdk.aws_dlm"
}
}
},
"aws-cdk-lib.aws_dms": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.DMS"
},
"java": {
"package": "software.amazon.awscdk.services.dms"
},
"python": {
"module": "aws_cdk.aws_dms"
}
}
},
"aws-cdk-lib.aws_docdb": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.DocDB"
},
"java": {
"package": "software.amazon.awscdk.services.docdb"
},
"python": {
"module": "aws_cdk.aws_docdb"
}
}
},
"aws-cdk-lib.aws_docdbelastic": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.DocDBElastic"
},
"java": {
"package": "software.amazon.awscdk.services.docdbelastic"
},
"python": {
"module": "aws_cdk.aws_docdbelastic"
}
}
},
"aws-cdk-lib.aws_dsql": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.DSQL"
},
"java": {
"package": "software.amazon.awscdk.services.dsql"
},
"python": {
"module": "aws_cdk.aws_dsql"
}
}
},
"aws-cdk-lib.aws_dynamodb": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.DynamoDB"
},
"java": {
"package": "software.amazon.awscdk.services.dynamodb"
},
"python": {
"module": "aws_cdk.aws_dynamodb"
}
}
},
"aws-cdk-lib.aws_ec2": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.EC2"
},
"java": {
"package": "software.amazon.awscdk.services.ec2"
},
"python": {
"module": "aws_cdk.aws_ec2"
}
}
},
"aws-cdk-lib.aws_ecr": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.ECR"
},
"java": {
"package": "software.amazon.awscdk.services.ecr"
},
"python": {
"module": "aws_cdk.aws_ecr"
}
}
},
"aws-cdk-lib.aws_ecr_assets": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Ecr.Assets"
},
"java": {
"package": "software.amazon.awscdk.services.ecr.assets"
},
"python": {
"module": "aws_cdk.aws_ecr_assets"
}
}
},
"aws-cdk-lib.aws_ecs": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.ECS"
},
"java": {
"package": "software.amazon.awscdk.services.ecs"
},
"python": {
"module": "aws_cdk.aws_ecs"
}
}
},
"aws-cdk-lib.aws_ecs_patterns": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.ECS.Patterns"
},
"java": {
"package": "software.amazon.awscdk.services.ecs.patterns"
},
"python": {
"module": "aws_cdk.aws_ecs_patterns"
}
}
},
"aws-cdk-lib.aws_efs": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.EFS"
},
"java": {
"package": "software.amazon.awscdk.services.efs"
},
"python": {
"module": "aws_cdk.aws_efs"
}
}
},
"aws-cdk-lib.aws_eks": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.EKS"
},
"java": {
"package": "software.amazon.awscdk.services.eks"
},
"python": {
"module": "aws_cdk.aws_eks"
}
}
},
"aws-cdk-lib.aws_elasticache": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.ElastiCache"
},
"java": {
"package": "software.amazon.awscdk.services.elasticache"
},
"python": {
"module": "aws_cdk.aws_elasticache"
}
}
},
"aws-cdk-lib.aws_elasticbeanstalk": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.ElasticBeanstalk"
},
"java": {
"package": "software.amazon.awscdk.services.elasticbeanstalk"
},
"python": {
"module": "aws_cdk.aws_elasticbeanstalk"
}
}
},
"aws-cdk-lib.aws_elasticloadbalancing": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.ElasticLoadBalancing"
},
"java": {
"package": "software.amazon.awscdk.services.elasticloadbalancing"
},
"python": {
"module": "aws_cdk.aws_elasticloadbalancing"
}
}
},
"aws-cdk-lib.aws_elasticloadbalancingv2": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.ElasticLoadBalancingV2"
},
"java": {
"package": "software.amazon.awscdk.services.elasticloadbalancingv2"
},
"python": {
"module": "aws_cdk.aws_elasticloadbalancingv2"
}
}
},
"aws-cdk-lib.aws_elasticloadbalancingv2_actions": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.ElasticLoadBalancingV2.Actions"
},
"java": {
"package": "software.amazon.awscdk.services.elasticloadbalancingv2.actions"
},
"python": {
"module": "aws_cdk.aws_elasticloadbalancingv2_actions"
}
}
},
"aws-cdk-lib.aws_elasticloadbalancingv2_targets": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.ElasticLoadBalancingV2.Targets"
},
"java": {
"package": "software.amazon.awscdk.services.elasticloadbalancingv2.targets"
},
"python": {
"module": "aws_cdk.aws_elasticloadbalancingv2_targets"
}
}
},
"aws-cdk-lib.aws_elasticsearch": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Elasticsearch"
},
"java": {
"package": "software.amazon.awscdk.services.elasticsearch"
},
"python": {
"module": "aws_cdk.aws_elasticsearch"
}
}
},
"aws-cdk-lib.aws_emr": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.EMR"
},
"java": {
"package": "software.amazon.awscdk.services.emr"
},
"python": {
"module": "aws_cdk.aws_emr"
}
}
},
"aws-cdk-lib.aws_emrcontainers": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.EMRContainers"
},
"java": {
"package": "software.amazon.awscdk.services.emrcontainers"
},
"python": {
"module": "aws_cdk.aws_emrcontainers"
}
}
},
"aws-cdk-lib.aws_emrserverless": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.EMRServerless"
},
"java": {
"package": "software.amazon.awscdk.services.emrserverless"
},
"python": {
"module": "aws_cdk.aws_emrserverless"
}
}
},
"aws-cdk-lib.aws_entityresolution": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.EntityResolution"
},
"java": {
"package": "software.amazon.awscdk.services.entityresolution"
},
"python": {
"module": "aws_cdk.aws_entityresolution"
}
}
},
"aws-cdk-lib.aws_events": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Events"
},
"java": {
"package": "software.amazon.awscdk.services.events"
},
"python": {
"module": "aws_cdk.aws_events"
}
}
},
"aws-cdk-lib.aws_events_targets": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Events.Targets"
},
"java": {
"package": "software.amazon.awscdk.services.events.targets"
},
"python": {
"module": "aws_cdk.aws_events_targets"
}
}
},
"aws-cdk-lib.aws_eventschemas": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.EventSchemas"
},
"java": {
"package": "software.amazon.awscdk.services.eventschemas"
},
"python": {
"module": "aws_cdk.aws_eventschemas"
}
}
},
"aws-cdk-lib.aws_evidently": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Evidently"
},
"java": {
"package": "software.amazon.awscdk.services.evidently"
},
"python": {
"module": "aws_cdk.aws_evidently"
}
}
},
"aws-cdk-lib.aws_evs": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.EVS"
},
"java": {
"package": "software.amazon.awscdk.services.evs"
},
"python": {
"module": "aws_cdk.aws_evs"
}
}
},
"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_gameliftstreams": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.GameLiftStreams"
},
"java": {
"package": "software.amazon.awscdk.services.gameliftstreams"
},
"python": {
"module": "aws_cdk.aws_gameliftstreams"
}
}
},
"aws-cdk-lib.aws_globalaccelerator": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.GlobalAccelerator"
},
"java": {
"package": "software.amazon.awscdk.services.globalaccelerator"
},
"python": {
"module": "aws_cdk.aws_globalaccelerator"
}
}
},
"aws-cdk-lib.aws_globalaccelerator_endpoints": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.GlobalAccelerator.Endpoints"
},
"java": {
"package": "software.amazon.awscdk.services.globalaccelerator.endpoints"
},
"python": {
"module": "aws_cdk.aws_globalaccelerator_endpoints"
}
}
},
"aws-cdk-lib.aws_glue": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Glue"
},
"java": {
"package": "software.amazon.awscdk.services.glue"
},
"python": {
"module": "aws_cdk.aws_glue"
}
}
},
"aws-cdk-lib.aws_grafana": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Grafana"
},
"java": {
"package": "software.amazon.awscdk.services.grafana"
},
"python": {
"module": "aws_cdk.aws_grafana"
}
}
},
"aws-cdk-lib.aws_greengrass": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Greengrass"
},
"java": {
"package": "software.amazon.awscdk.services.greengrass"
},
"python": {
"module": "aws_cdk.aws_greengrass"
}
}
},
"aws-cdk-lib.aws_greengrassv2": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.GreengrassV2"
},
"java": {
"package": "software.amazon.awscdk.services.greengrassv2"
},
"python": {
"module": "aws_cdk.aws_greengrassv2"
}
}
},
"aws-cdk-lib.aws_groundstation": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.GroundStation"
},
"java": {
"package": "software.amazon.awscdk.services.groundstation"
},
"python": {
"module": "aws_cdk.aws_groundstation"
}
}
},
"aws-cdk-lib.aws_guardduty": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.GuardDuty"
},
"java": {
"package": "software.amazon.awscdk.services.guardduty"
},
"python": {
"module": "aws_cdk.aws_guardduty"
}
}
},
"aws-cdk-lib.aws_healthimaging": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.HealthImaging"
},
"java": {
"package": "software.amazon.awscdk.services.healthimaging"
},
"python": {
"module": "aws_cdk.aws_healthimaging"
}
}
},
"aws-cdk-lib.aws_healthlake": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.HealthLake"
},
"java": {
"package": "software.amazon.awscdk.services.healthlake"
},
"python": {
"module": "aws_cdk.aws_healthlake"
}
}
},
"aws-cdk-lib.aws_iam": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.IAM"
},
"java": {
"package": "software.amazon.awscdk.services.iam"
},
"python": {
"module": "aws_cdk.aws_iam"
}
}
},
"aws-cdk-lib.aws_identitystore": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.IdentityStore"
},
"java": {
"package": "software.amazon.awscdk.services.identitystore"
},
"python": {
"module": "aws_cdk.aws_identitystore"
}
}
},
"aws-cdk-lib.aws_imagebuilder": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.ImageBuilder"
},
"java": {
"package": "software.amazon.awscdk.services.imagebuilder"
},
"python": {
"module": "aws_cdk.aws_imagebuilder"
}
}
},
"aws-cdk-lib.aws_inspector": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Inspector"
},
"java": {
"package": "software.amazon.awscdk.services.inspector"
},
"python": {
"module": "aws_cdk.aws_inspector"
}
}
},
"aws-cdk-lib.aws_inspectorv2": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.InspectorV2"
},
"java": {
"package": "software.amazon.awscdk.services.inspectorv2"
},
"python": {
"module": "aws_cdk.aws_inspectorv2"
}
}
},
"aws-cdk-lib.aws_internetmonitor": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.InternetMonitor"
},
"java": {
"package": "software.amazon.awscdk.services.internetmonitor"
},
"python": {
"module": "aws_cdk.aws_internetmonitor"
}
}
},
"aws-cdk-lib.aws_invoicing": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.Invoicing"
},
"java": {
"package": "software.amazon.awscdk.services.invoicing"
},
"python": {
"module": "aws_cdk.aws_invoicing"
}
}
},
"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_iotanalytics": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.IoTAnalytics"
},
"java": {
"package": "software.amazon.awscdk.services.iotanalytics"
},
"python": {
"module": "aws_cdk.aws_iotanalytics"
}
}
},
"aws-cdk-lib.aws_iotcoredeviceadvisor": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.IoTCoreDeviceAdvisor"
},
"java": {
"package": "software.amazon.awscdk.services.iotcoredeviceadvisor"
},
"python": {
"module": "aws_cdk.aws_iotcoredeviceadvisor"
}
}
},
"aws-cdk-lib.aws_iotevents": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.IoTEvents"
},
"java": {
"package": "software.amazon.awscdk.services.iotevents"
},
"python": {
"module": "aws_cdk.aws_iotevents"
}
}
},
"aws-cdk-lib.aws_iotfleethub": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.IoTFleetHub"
},
"java": {
"package": "software.amazon.awscdk.services.iotfleethub"
},
"python": {
"module": "aws_cdk.aws_iotfleethub"
}
}
},
"aws-cdk-lib.aws_iotfleetwise": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.IoTFleetWise"
},
"java": {
"package": "software.amazon.awscdk.services.iotfleetwise"
},
"python": {
"module": "aws_cdk.aws_iotfleetwise"
}
}
},
"aws-cdk-lib.aws_iotsitewise": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.IoTSiteWise"
},
"java": {
"package": "software.amazon.awscdk.services.iotsitewise"
},
"python": {
"module": "aws_cdk.aws_iotsitewise"
}
}
},
"aws-cdk-lib.aws_iotthingsgraph": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.IoTThingsGraph"
},
"java": {
"package": "software.amazon.awscdk.services.iotthingsgraph"
},
"python": {
"module": "aws_cdk.aws_iotthingsgraph"
}
}
},
"aws-cdk-lib.aws_iottwinmaker": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.IoTTwinMaker"
},
"java": {
"package": "software.amazon.awscdk.services.iottwinmaker"
},
"python": {
"module": "aws_cdk.aws_iottwinmaker"
}
}
},
"aws-cdk-lib.aws_iotwireless": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.IoTWireless"
},
"java": {
"package": "software.amazon.awscdk.services.iotwireless"
},
"python": {
"module": "aws_cdk.aws_iotwireless"
}
}
},
"aws-cdk-lib.aws_ivs": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Ivs"
},
"java": {
"package": "software.amazon.awscdk.services.ivs"
},
"python": {
"module": "aws_cdk.aws_ivs"
}
}
},
"aws-cdk-lib.aws_ivschat": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.IVSChat"
},
"java": {
"package": "software.amazon.awscdk.services.ivschat"
},
"python": {
"module": "aws_cdk.aws_ivschat"
}
}
},
"aws-cdk-lib.aws_kafkaconnect": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.KafkaConnect"
},
"java": {
"package": "software.amazon.awscdk.services.kafkaconnect"
},
"python": {
"module": "aws_cdk.aws_kafkaconnect"
}
}
},
"aws-cdk-lib.aws_kendra": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Kendra"
},
"java": {
"package": "software.amazon.awscdk.services.kendra"
},
"python": {
"module": "aws_cdk.aws_kendra"
}
}
},
"aws-cdk-lib.aws_kendraranking": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.KendraRanking"
},
"java": {
"package": "software.amazon.awscdk.services.kendraranking"
},
"python": {
"module": "aws_cdk.aws_kendraranking"
}
}
},
"aws-cdk-lib.aws_kinesis": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Kinesis"
},
"java": {
"package": "software.amazon.awscdk.services.kinesis"
},
"python": {
"module": "aws_cdk.aws_kinesis"
}
}
},
"aws-cdk-lib.aws_kinesisanalytics": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.KinesisAnalytics"
},
"java": {
"package": "software.amazon.awscdk.services.kinesisanalytics"
},
"python": {
"module": "aws_cdk.aws_kinesisanalytics"
}
}
},
"aws-cdk-lib.aws_kinesisanalyticsv2": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.KinesisAnalyticsV2"
},
"java": {
"package": "software.amazon.awscdk.services.kinesisanalyticsv2"
},
"python": {
"module": "aws_cdk.aws_kinesisanalyticsv2"
}
}
},
"aws-cdk-lib.aws_kinesisfirehose": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.KinesisFirehose"
},
"java": {
"package": "software.amazon.awscdk.services.kinesisfirehose"
},
"python": {
"module": "aws_cdk.aws_kinesisfirehose"
}
}
},
"aws-cdk-lib.aws_kinesisvideo": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.KinesisVideo"
},
"java": {
"package": "software.amazon.awscdk.services.kinesisvideo"
},
"python": {
"module": "aws_cdk.aws_kinesisvideo"
}
}
},
"aws-cdk-lib.aws_kms": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.KMS"
},
"java": {
"package": "software.amazon.awscdk.services.kms"
},
"python": {
"module": "aws_cdk.aws_kms"
}
}
},
"aws-cdk-lib.aws_lakeformation": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.LakeFormation"
},
"java": {
"package": "software.amazon.awscdk.services.lakeformation"
},
"python": {
"module": "aws_cdk.aws_lakeformation"
}
}
},
"aws-cdk-lib.aws_lambda": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Lambda"
},
"java": {
"package": "software.amazon.awscdk.services.lambda"
},
"python": {
"module": "aws_cdk.aws_lambda"
}
}
},
"aws-cdk-lib.aws_lambda_destinations": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Lambda.Destinations"
},
"java": {
"package": "software.amazon.awscdk.services.lambda.destinations"
},
"python": {
"module": "aws_cdk.aws_lambda_destinations"
}
}
},
"aws-cdk-lib.aws_lambda_event_sources": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Lambda.EventSources"
},
"java": {
"package": "software.amazon.awscdk.services.lambda.eventsources"
},
"python": {
"module": "aws_cdk.aws_lambda_event_sources"
}
}
},
"aws-cdk-lib.aws_lambda_nodejs": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Lambda.Nodejs"
},
"java": {
"package": "software.amazon.awscdk.services.lambda.nodejs"
},
"python": {
"module": "aws_cdk.aws_lambda_nodejs"
}
}
},
"aws-cdk-lib.aws_launchwizard": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.LaunchWizard"
},
"java": {
"package": "software.amazon.awscdk.services.launchwizard"
},
"python": {
"module": "aws_cdk.aws_launchwizard"
}
}
},
"aws-cdk-lib.aws_lex": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Lex"
},
"java": {
"package": "software.amazon.awscdk.services.lex"
},
"python": {
"module": "aws_cdk.aws_lex"
}
}
},
"aws-cdk-lib.aws_licensemanager": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.LicenseManager"
},
"java": {
"package": "software.amazon.awscdk.services.licensemanager"
},
"python": {
"module": "aws_cdk.aws_licensemanager"
}
}
},
"aws-cdk-lib.aws_lightsail": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Lightsail"
},
"java": {
"package": "software.amazon.awscdk.services.lightsail"
},
"python": {
"module": "aws_cdk.aws_lightsail"
}
}
},
"aws-cdk-lib.aws_location": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Location"
},
"java": {
"package": "software.amazon.awscdk.services.location"
},
"python": {
"module": "aws_cdk.aws_location"
}
}
},
"aws-cdk-lib.aws_logs": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Logs"
},
"java": {
"package": "software.amazon.awscdk.services.logs"
},
"python": {
"module": "aws_cdk.aws_logs"
}
}
},
"aws-cdk-lib.aws_logs_destinations": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Logs.Destinations"
},
"java": {
"package": "software.amazon.awscdk.services.logs.destinations"
},
"python": {
"module": "aws_cdk.aws_logs_destinations"
}
}
},
"aws-cdk-lib.aws_lookoutequipment": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.LookoutEquipment"
},
"java": {
"package": "software.amazon.awscdk.services.lookoutequipment"
},
"python": {
"module": "aws_cdk.aws_lookoutequipment"
}
}
},
"aws-cdk-lib.aws_lookoutmetrics": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.LookoutMetrics"
},
"java": {
"package": "software.amazon.awscdk.services.lookoutmetrics"
},
"python": {
"module": "aws_cdk.aws_lookoutmetrics"
}
}
},
"aws-cdk-lib.aws_lookoutvision": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.LookoutVision"
},
"java": {
"package": "software.amazon.awscdk.services.lookoutvision"
},
"python": {
"module": "aws_cdk.aws_lookoutvision"
}
}
},
"aws-cdk-lib.aws_m2": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.M2"
},
"java": {
"package": "software.amazon.awscdk.services.m2"
},
"python": {
"module": "aws_cdk.aws_m2"
}
}
},
"aws-cdk-lib.aws_macie": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Macie"
},
"java": {
"package": "software.amazon.awscdk.services.macie"
},
"python": {
"module": "aws_cdk.aws_macie"
}
}
},
"aws-cdk-lib.aws_managedblockchain": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.ManagedBlockchain"
},
"java": {
"package": "software.amazon.awscdk.services.managedblockchain"
},
"python": {
"module": "aws_cdk.aws_managedblockchain"
}
}
},
"aws-cdk-lib.aws_mediaconnect": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.MediaConnect"
},
"java": {
"package": "software.amazon.awscdk.services.mediaconnect"
},
"python": {
"module": "aws_cdk.aws_mediaconnect"
}
}
},
"aws-cdk-lib.aws_mediaconvert": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.MediaConvert"
},
"java": {
"package": "software.amazon.awscdk.services.mediaconvert"
},
"python": {
"module": "aws_cdk.aws_mediaconvert"
}
}
},
"aws-cdk-lib.aws_medialive": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.MediaLive"
},
"java": {
"package": "software.amazon.awscdk.services.medialive"
},
"python": {
"module": "aws_cdk.aws_medialive"
}
}
},
"aws-cdk-lib.aws_mediapackage": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.MediaPackage"
},
"java": {
"package": "software.amazon.awscdk.services.mediapackage"
},
"python": {
"module": "aws_cdk.aws_mediapackage"
}
}
},
"aws-cdk-lib.aws_mediapackagev2": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.MediaPackageV2"
},
"java": {
"package": "software.amazon.awscdk.services.mediapackagev2"
},
"python": {
"module": "aws_cdk.aws_mediapackagev2"
}
}
},
"aws-cdk-lib.aws_mediastore": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.MediaStore"
},
"java": {
"package": "software.amazon.awscdk.services.mediastore"
},
"python": {
"module": "aws_cdk.aws_mediastore"
}
}
},
"aws-cdk-lib.aws_mediatailor": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.MediaTailor"
},
"java": {
"package": "software.amazon.awscdk.services.mediatailor"
},
"python": {
"module": "aws_cdk.aws_mediatailor"
}
}
},
"aws-cdk-lib.aws_memorydb": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.MemoryDB"
},
"java": {
"package": "software.amazon.awscdk.services.memorydb"
},
"python": {
"module": "aws_cdk.aws_memorydb"
}
}
},
"aws-cdk-lib.aws_mpa": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.MPA"
},
"java": {
"package": "software.amazon.awscdk.services.mpa"
},
"python": {
"module": "aws_cdk.aws_mpa"
}
}
},
"aws-cdk-lib.aws_msk": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.MSK"
},
"java": {
"package": "software.amazon.awscdk.services.msk"
},
"python": {
"module": "aws_cdk.aws_msk"
}
}
},
"aws-cdk-lib.aws_mwaa": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.MWAA"
},
"java": {
"package": "software.amazon.awscdk.services.mwaa"
},
"python": {
"module": "aws_cdk.aws_mwaa"
}
}
},
"aws-cdk-lib.aws_neptune": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Neptune"
},
"java": {
"package": "software.amazon.awscdk.services.neptune"
},
"python": {
"module": "aws_cdk.aws_neptune"
}
}
},
"aws-cdk-lib.aws_neptunegraph": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.NeptuneGraph"
},
"java": {
"package": "software.amazon.awscdk.services.neptunegraph"
},
"python": {
"module": "aws_cdk.aws_neptunegraph"
}
}
},
"aws-cdk-lib.aws_networkfirewall": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.NetworkFirewall"
},
"java": {
"package": "software.amazon.awscdk.services.networkfirewall"
},
"python": {
"module": "aws_cdk.aws_networkfirewall"
}
}
},
"aws-cdk-lib.aws_networkmanager": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.NetworkManager"
},
"java": {
"package": "software.amazon.awscdk.services.networkmanager"
},
"python": {
"module": "aws_cdk.aws_networkmanager"
}
}
},
"aws-cdk-lib.aws_nimblestudio": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.NimbleStudio"
},
"java": {
"package": "software.amazon.awscdk.services.nimblestudio"
},
"python": {
"module": "aws_cdk.aws_nimblestudio"
}
}
},
"aws-cdk-lib.aws_notifications": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.Notifications"
},
"java": {
"package": "software.amazon.awscdk.services.notifications"
},
"python": {
"module": "aws_cdk.aws_notifications"
}
}
},
"aws-cdk-lib.aws_notificationscontacts": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.NotificationsContacts"
},
"java": {
"package": "software.amazon.awscdk.services.notificationscontacts"
},
"python": {
"module": "aws_cdk.aws_notificationscontacts"
}
}
},
"aws-cdk-lib.aws_oam": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Oam"
},
"java": {
"package": "software.amazon.awscdk.services.oam"
},
"python": {
"module": "aws_cdk.aws_oam"
}
}
},
"aws-cdk-lib.aws_odb": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.ODB"
},
"java": {
"package": "software.amazon.awscdk.services.odb"
},
"python": {
"module": "aws_cdk.aws_odb"
}
}
},
"aws-cdk-lib.aws_omics": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Omics"
},
"java": {
"package": "software.amazon.awscdk.services.omics"
},
"python": {
"module": "aws_cdk.aws_omics"
}
}
},
"aws-cdk-lib.aws_opensearchserverless": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.OpenSearchServerless"
},
"java": {
"package": "software.amazon.awscdk.services.opensearchserverless"
},
"python": {
"module": "aws_cdk.aws_opensearchserverless"
}
}
},
"aws-cdk-lib.aws_opensearchservice": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.OpenSearchService"
},
"java": {
"package": "software.amazon.awscdk.services.opensearchservice"
},
"python": {
"module": "aws_cdk.aws_opensearchservice"
}
}
},
"aws-cdk-lib.aws_opsworks": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.OpsWorks"
},
"java": {
"package": "software.amazon.awscdk.services.opsworks"
},
"python": {
"module": "aws_cdk.aws_opsworks"
}
}
},
"aws-cdk-lib.aws_opsworkscm": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.OpsWorksCM"
},
"java": {
"package": "software.amazon.awscdk.services.opsworkscm"
},
"python": {
"module": "aws_cdk.aws_opsworkscm"
}
}
},
"aws-cdk-lib.aws_organizations": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Organizations"
},
"java": {
"package": "software.amazon.awscdk.services.organizations"
},
"python": {
"module": "aws_cdk.aws_organizations"
}
}
},
"aws-cdk-lib.aws_osis": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.OSIS"
},
"java": {
"package": "software.amazon.awscdk.services.osis"
},
"python": {
"module": "aws_cdk.aws_osis"
}
}
},
"aws-cdk-lib.aws_panorama": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Panorama"
},
"java": {
"package": "software.amazon.awscdk.services.panorama"
},
"python": {
"module": "aws_cdk.aws_panorama"
}
}
},
"aws-cdk-lib.aws_paymentcryptography": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.PaymentCryptography"
},
"java": {
"package": "software.amazon.awscdk.services.paymentcryptography"
},
"python": {
"module": "aws_cdk.aws_paymentcryptography"
}
}
},
"aws-cdk-lib.aws_pcaconnectorad": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.PCAConnectorAD"
},
"java": {
"package": "software.amazon.awscdk.services.pcaconnectorad"
},
"python": {
"module": "aws_cdk.aws_pcaconnectorad"
}
}
},
"aws-cdk-lib.aws_pcaconnectorscep": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.PCAConnectorSCEP"
},
"java": {
"package": "software.amazon.awscdk.services.pcaconnectorscep"
},
"python": {
"module": "aws_cdk.aws_pcaconnectorscep"
}
}
},
"aws-cdk-lib.aws_pcs": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.PCS"
},
"java": {
"package": "software.amazon.awscdk.services.pcs"
},
"python": {
"module": "aws_cdk.aws_pcs"
}
}
},
"aws-cdk-lib.aws_personalize": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Personalize"
},
"java": {
"package": "software.amazon.awscdk.services.personalize"
},
"python": {
"module": "aws_cdk.aws_personalize"
}
}
},
"aws-cdk-lib.aws_pinpoint": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Pinpoint"
},
"java": {
"package": "software.amazon.awscdk.services.pinpoint"
},
"python": {
"module": "aws_cdk.aws_pinpoint"
}
}
},
"aws-cdk-lib.aws_pinpointemail": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.PinpointEmail"
},
"java": {
"package": "software.amazon.awscdk.services.pinpointemail"
},
"python": {
"module": "aws_cdk.aws_pinpointemail"
}
}
},
"aws-cdk-lib.aws_pipes": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Pipes"
},
"java": {
"package": "software.amazon.awscdk.services.pipes"
},
"python": {
"module": "aws_cdk.aws_pipes"
}
}
},
"aws-cdk-lib.aws_proton": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.Proton"
},
"java": {
"package": "software.amazon.awscdk.services.proton"
},
"python": {
"module": "aws_cdk.aws_proton"
}
}
},
"aws-cdk-lib.aws_qbusiness": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.QBusiness"
},
"java": {
"package": "software.amazon.awscdk.services.qbusiness"
},
"python": {
"module": "aws_cdk.aws_qbusiness"
}
}
},
"aws-cdk-lib.aws_qldb": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.QLDB"
},
"java": {
"package": "software.amazon.awscdk.services.qldb"
},
"python": {
"module": "aws_cdk.aws_qldb"
}
}
},
"aws-cdk-lib.aws_quicksight": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.QuickSight"
},
"java": {
"package": "software.amazon.awscdk.services.quicksight"
},
"python": {
"module": "aws_cdk.aws_quicksight"
}
}
},
"aws-cdk-lib.aws_ram": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.RAM"
},
"java": {
"package": "software.amazon.awscdk.services.ram"
},
"python": {
"module": "aws_cdk.aws_ram"
}
}
},
"aws-cdk-lib.aws_rbin": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.Rbin"
},
"java": {
"package": "software.amazon.awscdk.services.rbin"
},
"python": {
"module": "aws_cdk.aws_rbin"
}
}
},
"aws-cdk-lib.aws_rds": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.RDS"
},
"java": {
"package": "software.amazon.awscdk.services.rds"
},
"python": {
"module": "aws_cdk.aws_rds"
}
}
},
"aws-cdk-lib.aws_redshift": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Redshift"
},
"java": {
"package": "software.amazon.awscdk.services.redshift"
},
"python": {
"module": "aws_cdk.aws_redshift"
}
}
},
"aws-cdk-lib.aws_redshiftserverless": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.RedshiftServerless"
},
"java": {
"package": "software.amazon.awscdk.services.redshiftserverless"
},
"python": {
"module": "aws_cdk.aws_redshiftserverless"
}
}
},
"aws-cdk-lib.aws_refactorspaces": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.RefactorSpaces"
},
"java": {
"package": "software.amazon.awscdk.services.refactorspaces"
},
"python": {
"module": "aws_cdk.aws_refactorspaces"
}
}
},
"aws-cdk-lib.aws_rekognition": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Rekognition"
},
"java": {
"package": "software.amazon.awscdk.services.rekognition"
},
"python": {
"module": "aws_cdk.aws_rekognition"
}
}
},
"aws-cdk-lib.aws_resiliencehub": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.ResilienceHub"
},
"java": {
"package": "software.amazon.awscdk.services.resiliencehub"
},
"python": {
"module": "aws_cdk.aws_resiliencehub"
}
}
},
"aws-cdk-lib.aws_resourceexplorer2": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.ResourceExplorer2"
},
"java": {
"package": "software.amazon.awscdk.services.resourceexplorer2"
},
"python": {
"module": "aws_cdk.aws_resourceexplorer2"
}
}
},
"aws-cdk-lib.aws_resourcegroups": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.ResourceGroups"
},
"java": {
"package": "software.amazon.awscdk.services.resourcegroups"
},
"python": {
"module": "aws_cdk.aws_resourcegroups"
}
}
},
"aws-cdk-lib.aws_robomaker": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.RoboMaker"
},
"java": {
"package": "software.amazon.awscdk.services.robomaker"
},
"python": {
"module": "aws_cdk.aws_robomaker"
}
}
},
"aws-cdk-lib.aws_rolesanywhere": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.RolesAnywhere"
},
"java": {
"package": "software.amazon.awscdk.services.rolesanywhere"
},
"python": {
"module": "aws_cdk.aws_rolesanywhere"
}
}
},
"aws-cdk-lib.aws_route53": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Route53"
},
"java": {
"package": "software.amazon.awscdk.services.route53"
},
"python": {
"module": "aws_cdk.aws_route53"
}
}
},
"aws-cdk-lib.aws_route53_patterns": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Route53.Patterns"
},
"java": {
"package": "software.amazon.awscdk.services.route53.patterns"
},
"python": {
"module": "aws_cdk.aws_route53_patterns"
}
}
},
"aws-cdk-lib.aws_route53_targets": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Route53.Targets"
},
"java": {
"package": "software.amazon.awscdk.services.route53.targets"
},
"python": {
"module": "aws_cdk.aws_route53_targets"
}
}
},
"aws-cdk-lib.aws_route53profiles": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.Route53Profiles"
},
"java": {
"package": "software.amazon.awscdk.services.route53profiles"
},
"python": {
"module": "aws_cdk.aws_route53profiles"
}
}
},
"aws-cdk-lib.aws_route53recoverycontrol": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Route53RecoveryControl"
},
"java": {
"package": "software.amazon.awscdk.services.route53recoverycontrol"
},
"python": {
"module": "aws_cdk.aws_route53recoverycontrol"
}
}
},
"aws-cdk-lib.aws_route53recoveryreadiness": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Route53RecoveryReadiness"
},
"java": {
"package": "software.amazon.awscdk.services.route53recoveryreadiness"
},
"python": {
"module": "aws_cdk.aws_route53recoveryreadiness"
}
}
},
"aws-cdk-lib.aws_route53resolver": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Route53Resolver"
},
"java": {
"package": "software.amazon.awscdk.services.route53resolver"
},
"python": {
"module": "aws_cdk.aws_route53resolver"
}
}
},
"aws-cdk-lib.aws_rum": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.RUM"
},
"java": {
"package": "software.amazon.awscdk.services.rum"
},
"python": {
"module": "aws_cdk.aws_rum"
}
}
},
"aws-cdk-lib.aws_s3": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.S3"
},
"java": {
"package": "software.amazon.awscdk.services.s3"
},
"python": {
"module": "aws_cdk.aws_s3"
}
}
},
"aws-cdk-lib.aws_s3_assets": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.S3.Assets"
},
"java": {
"package": "software.amazon.awscdk.services.s3.assets"
},
"python": {
"module": "aws_cdk.aws_s3_assets"
}
}
},
"aws-cdk-lib.aws_s3_deployment": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.S3.Deployment"
},
"java": {
"package": "software.amazon.awscdk.services.s3.deployment"
},
"python": {
"module": "aws_cdk.aws_s3_deployment"
}
}
},
"aws-cdk-lib.aws_s3_notifications": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.S3.Notifications"
},
"java": {
"package": "software.amazon.awscdk.services.s3.notifications"
},
"python": {
"module": "aws_cdk.aws_s3_notifications"
}
}
},
"aws-cdk-lib.aws_s3express": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.S3Express"
},
"java": {
"package": "software.amazon.awscdk.services.s3express"
},
"python": {
"module": "aws_cdk.aws_s3express"
}
}
},
"aws-cdk-lib.aws_s3objectlambda": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.S3ObjectLambda"
},
"java": {
"package": "software.amazon.awscdk.services.s3objectlambda"
},
"python": {
"module": "aws_cdk.aws_s3objectlambda"
}
}
},
"aws-cdk-lib.aws_s3outposts": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.S3Outposts"
},
"java": {
"package": "software.amazon.awscdk.services.s3outposts"
},
"python": {
"module": "aws_cdk.aws_s3outposts"
}
}
},
"aws-cdk-lib.aws_s3tables": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.S3Tables"
},
"java": {
"package": "software.amazon.awscdk.services.s3tables"
},
"python": {
"module": "aws_cdk.aws_s3tables"
}
}
},
"aws-cdk-lib.aws_sagemaker": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Sagemaker"
},
"java": {
"package": "software.amazon.awscdk.services.sagemaker"
},
"python": {
"module": "aws_cdk.aws_sagemaker"
}
}
},
"aws-cdk-lib.aws_sam": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.SAM"
},
"java": {
"package": "software.amazon.awscdk.services.sam"
},
"python": {
"module": "aws_cdk.aws_sam"
}
}
},
"aws-cdk-lib.aws_scheduler": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Scheduler"
},
"java": {
"package": "software.amazon.awscdk.services.scheduler"
},
"python": {
"module": "aws_cdk.aws_scheduler"
}
}
},
"aws-cdk-lib.aws_scheduler_targets": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Scheduler.Targets"
},
"java": {
"package": "software.amazon.awscdk.services.scheduler.targets"
},
"python": {
"module": "aws_cdk.aws_scheduler_targets"
}
}
},
"aws-cdk-lib.aws_sdb": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.SDB"
},
"java": {
"package": "software.amazon.awscdk.services.sdb"
},
"python": {
"module": "aws_cdk.aws_sdb"
}
}
},
"aws-cdk-lib.aws_secretsmanager": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.SecretsManager"
},
"java": {
"package": "software.amazon.awscdk.services.secretsmanager"
},
"python": {
"module": "aws_cdk.aws_secretsmanager"
}
}
},
"aws-cdk-lib.aws_securityhub": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.SecurityHub"
},
"java": {
"package": "software.amazon.awscdk.services.securityhub"
},
"python": {
"module": "aws_cdk.aws_securityhub"
}
}
},
"aws-cdk-lib.aws_securitylake": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.SecurityLake"
},
"java": {
"package": "software.amazon.awscdk.services.securitylake"
},
"python": {
"module": "aws_cdk.aws_securitylake"
}
}
},
"aws-cdk-lib.aws_servicecatalog": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Servicecatalog"
},
"java": {
"package": "software.amazon.awscdk.services.servicecatalog"
},
"python": {
"module": "aws_cdk.aws_servicecatalog"
}
}
},
"aws-cdk-lib.aws_servicecatalogappregistry": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Servicecatalogappregistry"
},
"java": {
"package": "software.amazon.awscdk.services.servicecatalogappregistry"
},
"python": {
"module": "aws_cdk.aws_servicecatalogappregistry"
}
}
},
"aws-cdk-lib.aws_servicediscovery": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.ServiceDiscovery"
},
"java": {
"package": "software.amazon.awscdk.services.servicediscovery"
},
"python": {
"module": "aws_cdk.aws_servicediscovery"
}
}
},
"aws-cdk-lib.aws_ses": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.SES"
},
"java": {
"package": "software.amazon.awscdk.services.ses"
},
"python": {
"module": "aws_cdk.aws_ses"
}
}
},
"aws-cdk-lib.aws_ses_actions": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.SES.Actions"
},
"java": {
"package": "software.amazon.awscdk.services.ses.actions"
},
"python": {
"module": "aws_cdk.aws_ses_actions"
}
}
},
"aws-cdk-lib.aws_shield": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.Shield"
},
"java": {
"package": "software.amazon.awscdk.services.shield"
},
"python": {
"module": "aws_cdk.aws_shield"
}
}
},
"aws-cdk-lib.aws_signer": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Signer"
},
"java": {
"package": "software.amazon.awscdk.services.signer"
},
"python": {
"module": "aws_cdk.aws_signer"
}
}
},
"aws-cdk-lib.aws_simspaceweaver": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.SimSpaceWeaver"
},
"java": {
"package": "software.amazon.awscdk.services.simspaceweaver"
},
"python": {
"module": "aws_cdk.aws_simspaceweaver"
}
}
},
"aws-cdk-lib.aws_sns": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.SNS"
},
"java": {
"package": "software.amazon.awscdk.services.sns"
},
"python": {
"module": "aws_cdk.aws_sns"
}
}
},
"aws-cdk-lib.aws_sns_subscriptions": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.SNS.Subscriptions"
},
"java": {
"package": "software.amazon.awscdk.services.sns.subscriptions"
},
"python": {
"module": "aws_cdk.aws_sns_subscriptions"
}
}
},
"aws-cdk-lib.aws_sqs": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.SQS"
},
"java": {
"package": "software.amazon.awscdk.services.sqs"
},
"python": {
"module": "aws_cdk.aws_sqs"
}
}
},
"aws-cdk-lib.aws_ssm": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.SSM"
},
"java": {
"package": "software.amazon.awscdk.services.ssm"
},
"python": {
"module": "aws_cdk.aws_ssm"
}
}
},
"aws-cdk-lib.aws_ssmcontacts": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.SSMContacts"
},
"java": {
"package": "software.amazon.awscdk.services.ssmcontacts"
},
"python": {
"module": "aws_cdk.aws_ssmcontacts"
}
}
},
"aws-cdk-lib.aws_ssmguiconnect": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.SSMGuiConnect"
},
"java": {
"package": "software.amazon.awscdk.services.ssmguiconnect"
},
"python": {
"module": "aws_cdk.aws_ssmguiconnect"
}
}
},
"aws-cdk-lib.aws_ssmincidents": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.SSMIncidents"
},
"java": {
"package": "software.amazon.awscdk.services.ssmincidents"
},
"python": {
"module": "aws_cdk.aws_ssmincidents"
}
}
},
"aws-cdk-lib.aws_ssmquicksetup": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.SSMQuickSetup"
},
"java": {
"package": "software.amazon.awscdk.services.ssmquicksetup"
},
"python": {
"module": "aws_cdk.aws_ssmquicksetup"
}
}
},
"aws-cdk-lib.aws_sso": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.SSO"
},
"java": {
"package": "software.amazon.awscdk.services.sso"
},
"python": {
"module": "aws_cdk.aws_sso"
}
}
},
"aws-cdk-lib.aws_stepfunctions": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.StepFunctions"
},
"java": {
"package": "software.amazon.awscdk.services.stepfunctions"
},
"python": {
"module": "aws_cdk.aws_stepfunctions"
}
}
},
"aws-cdk-lib.aws_stepfunctions_tasks": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.StepFunctions.Tasks"
},
"java": {
"package": "software.amazon.awscdk.services.stepfunctions.tasks"
},
"python": {
"module": "aws_cdk.aws_stepfunctions_tasks"
}
}
},
"aws-cdk-lib.aws_supportapp": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.SupportApp"
},
"java": {
"package": "software.amazon.awscdk.services.supportapp"
},
"python": {
"module": "aws_cdk.aws_supportapp"
}
}
},
"aws-cdk-lib.aws_synthetics": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Synthetics"
},
"java": {
"package": "software.amazon.awscdk.services.synthetics"
},
"python": {
"module": "aws_cdk.aws_synthetics"
}
}
},
"aws-cdk-lib.aws_systemsmanagersap": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.SystemsManagerSAP"
},
"java": {
"package": "software.amazon.awscdk.services.systemsmanagersap"
},
"python": {
"module": "aws_cdk.aws_systemsmanagersap"
}
}
},
"aws-cdk-lib.aws_timestream": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Timestream"
},
"java": {
"package": "software.amazon.awscdk.services.timestream"
},
"python": {
"module": "aws_cdk.aws_timestream"
}
}
},
"aws-cdk-lib.aws_transfer": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Transfer"
},
"java": {
"package": "software.amazon.awscdk.services.transfer"
},
"python": {
"module": "aws_cdk.aws_transfer"
}
}
},
"aws-cdk-lib.aws_verifiedpermissions": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.VerifiedPermissions"
},
"java": {
"package": "software.amazon.awscdk.services.verifiedpermissions"
},
"python": {
"module": "aws_cdk.aws_verifiedpermissions"
}
}
},
"aws-cdk-lib.aws_voiceid": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.VoiceID"
},
"java": {
"package": "software.amazon.awscdk.services.voiceid"
},
"python": {
"module": "aws_cdk.aws_voiceid"
}
}
},
"aws-cdk-lib.aws_vpclattice": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.VpcLattice"
},
"java": {
"package": "software.amazon.awscdk.services.vpclattice"
},
"python": {
"module": "aws_cdk.aws_vpclattice"
}
}
},
"aws-cdk-lib.aws_waf": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.WAF"
},
"java": {
"package": "software.amazon.awscdk.services.waf"
},
"python": {
"module": "aws_cdk.aws_waf"
}
}
},
"aws-cdk-lib.aws_wafregional": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.WAFRegional"
},
"java": {
"package": "software.amazon.awscdk.services.waf.regional"
},
"python": {
"module": "aws_cdk.aws_wafregional"
}
}
},
"aws-cdk-lib.aws_wafv2": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.WAFv2"
},
"java": {
"package": "software.amazon.awscdk.services.wafv2"
},
"python": {
"module": "aws_cdk.aws_wafv2"
}
}
},
"aws-cdk-lib.aws_wisdom": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.Wisdom"
},
"java": {
"package": "software.amazon.awscdk.services.wisdom"
},
"python": {
"module": "aws_cdk.aws_wisdom"
}
}
},
"aws-cdk-lib.aws_workspaces": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.WorkSpaces"
},
"java": {
"package": "software.amazon.awscdk.services.workspaces"
},
"python": {
"module": "aws_cdk.aws_workspaces"
}
}
},
"aws-cdk-lib.aws_workspacesinstances": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.WorkspacesInstances"
},
"java": {
"package": "software.amazon.awscdk.services.workspacesinstances"
},
"python": {
"module": "aws_cdk.aws_workspacesinstances"
}
}
},
"aws-cdk-lib.aws_workspacesthinclient": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.WorkSpacesThinClient"
},
"java": {
"package": "software.amazon.awscdk.services.workspacesthinclient"
},
"python": {
"module": "aws_cdk.aws_workspacesthinclient"
}
}
},
"aws-cdk-lib.aws_workspacesweb": {
"targets": {
"dotnet": {
"package": "Amazon.CDK.AWS.WorkSpacesWeb"
},
"java": {
"package": "software.amazon.awscdk.services.workspacesweb"
},
"python": {
"module": "aws_cdk.aws_workspacesweb"
}
}
},
"aws-cdk-lib.aws_xray": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.AWS.XRay"
},
"java": {
"package": "software.amazon.awscdk.services.xray"
},
"python": {
"module": "aws_cdk.aws_xray"
}
}
},
"aws-cdk-lib.cloud_assembly_schema": {},
"aws-cdk-lib.cloudformation_include": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.CloudFormation.Include"
},
"java": {
"package": "software.amazon.awscdk.cloudformation.include"
},
"python": {
"module": "aws_cdk.cloudformation_include"
}
}
},
"aws-cdk-lib.custom_resources": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.CustomResources"
},
"java": {
"package": "software.amazon.awscdk.customresources"
},
"python": {
"module": "aws_cdk.custom_resources"
}
}
},
"aws-cdk-lib.cx_api": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.CXAPI"
},
"java": {
"package": "software.amazon.awscdk.cxapi"
},
"python": {
"module": "aws_cdk.cx_api"
}
}
},
"aws-cdk-lib.lambda_layer_awscli": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.LambdaLayer.AwsCli"
},
"java": {
"package": "software.amazon.awscdk.lambdalayer.awscli"
},
"python": {
"module": "aws_cdk.lambda_layer_awscli"
}
}
},
"aws-cdk-lib.lambda_layer_node_proxy_agent": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.LambdaLayer.NodeProxyAgent"
},
"java": {
"package": "software.amazon.awscdk.lambda.layer.node.proxy.agent"
},
"python": {
"module": "aws_cdk.lambda_layer_node_proxy_agent"
}
}
},
"aws-cdk-lib.pipelines": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.Pipelines"
},
"java": {
"package": "software.amazon.awscdk.pipelines"
},
"python": {
"module": "aws_cdk.pipelines"
}
}
},
"aws-cdk-lib.region_info": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.RegionInfo"
},
"java": {
"package": "software.amazon.awscdk.regioninfo"
},
"python": {
"module": "aws_cdk.region_info"
}
}
},
"aws-cdk-lib.triggers": {
"targets": {
"dotnet": {
"namespace": "Amazon.CDK.Triggers"
},
"java": {
"package": "software.amazon.awscdk.triggers"
},
"python": {
"module": "aws_cdk.triggers"
}
}
}
},
"targets": {
"dotnet": {
"iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/main/logo/default-256-dark.png",
"namespace": "Amazon.CDK",
"packageId": "Amazon.CDK.Lib"
},
"go": {
"moduleName": "github.com/aws/aws-cdk-go",
"packageName": "awscdk"
},
"java": {
"maven": {
"artifactId": "aws-cdk-lib",
"groupId": "software.amazon.awscdk"
},
"package": "software.amazon.awscdk"
},
"js": {
"npm": "aws-cdk-lib"
},
"python": {
"distName": "aws-cdk-lib",
"module": "aws_cdk"
}
}
},
"constructs": {
"targets": {
"dotnet": {
"namespace": "Constructs",
"packageId": "Constructs"
},
"go": {
"moduleName": "github.com/aws/constructs-go"
},
"java": {
"maven": {
"artifactId": "constructs",
"groupId": "software.constructs"
},
"package": "software.constructs"
},
"js": {
"npm": "constructs"
},
"python": {
"distName": "constructs",
"module": "constructs"
}
}
}
},
"description": "AWS CDK Construct Library to automatically create CloudWatch Alarms for resources in a CDK app based on resource type.",
"docs": {
"stability": "stable"
},
"homepage": "https://github.com/RenovoSolutions/cdk-library-cloudwatch-alarms.git",
"jsiiVersion": "5.8.15 (build af1b019)",
"keywords": [
"alarms",
"aws-cdk",
"aws-cdk-construct",
"cdk",
"cloudwatch",
"projen"
],
"license": "Apache-2.0",
"metadata": {
"jsii": {
"pacmak": {
"hasDefaultInterfaces": true
}
},
"tscRootDir": "src"
},
"name": "@renovosolutions/cdk-library-cloudwatch-alarms",
"readme": {
"markdown": "# cdk-library-cloudwatch-alarms\n\nWIP - Library to provide constructs, aspects, and construct extensions to more easily set up alarms for AWS resources in CDK code based on AWS recommended alarms list. This project is still in early development so YMMV.\n\n## Usage\n\nThis library is flexible in its approach and there are multiple paths to configuring alarms depending on how you'd like to work with the recommended alarms.\n\n## Feature Availability\n\nIntended feature list as of Aug 2024\n\n- [x] Aspects to apply recommended alarms to a wide scope such as a whole CDK app\n - [x] Ability to exclude specific alarms\n - [x] Ability to define a default set of alarm actions\n - [x] Ability to modify the configuration of each alarm type\n - [ ] Ability to exclude specific resources\n- [x] Constructs to ease alarm configuration for individual resources at a granular scope\n - [x] Constructs for each available alarm according to the coverage table\n - [x] Constructs for applying all recommended alarms to a specific resource\n - [x] Ability to exclude specific alarms from the all recommended alarms construct\n- [x] Extended versions of resource constructs with alarm helper methods\n\n## Resource Coverage\n\nIf it's not shown it hasn't been worked on.\n\n| Service | Status | Notes |\n| --- | --- | --- |\n| S3 | - [x] 4xxErrors
- [x] 5xxErrors
- [ ] OperationsFailedReplication | Replication errors are difficult to set up in CDK at the moment due to rule properties being IResolvables and replication rules not being available on the L2 Bucket construct |\n| SQS | - [x] ApproximateAgeOfOldestMessage
- [x] ApproximateNumberOfMessagesNotVisible
- [x] ApproximateNumberOfMessagesVisible
- [x] NumberOfMessagesSent |- All alarms with the exception of number of messages sent require a user defined threshold because its very use-case specific.
- The Aspect only assigns DLQs the `ApproximateNumberOfMessagesVisible` alarm with a default threshold of 0, unless `dlqsGetFullRecommendedAlarms` is `true`, in which case they get the same alarms as other queues. DLQs that belong to a main queue which isn't in the same scope as the Aspect is added to won't be detected as DLQs and they will be treated as normal queues. |\n| SNS | - [x] NumberOfMessagesPublished
- [x] NumberOfNotificationsDelivered
- [x] NumberOfNotificationsFailed
- [x] NumberOfNotificationsFilteredOut-InvalidAttributes
- [x] NumberOfNotificationsFilteredOut-InvalidMessageBody
- [x] NumberOfNotificationsRedrivenToDlq
- [x] NumberOfNotificationsFailedToRedriveToDlq
- [ ] SMSMonthToDateSpentUSD
- [ ] SMSSuccessRate | Some alarms require a threshold to be defined. SMS alarms are not implememented. |\n| Lambda | - [ ] ClaimedAccountConcurrency
- [x] Errors
- [x] Throttles
- [x] Duration
- [x] ConcurrentExecutions | ClaimedAccountConcurrency is account wide and one time so not covered by this library at this time |\n| RDS | **For database & cluster instances**
- [x] CPUUtilization
- [x] DatabaseConnections
- [x] FreeableMemory
- [x] FreeLocalStorage
- [x] FreeStorageSpace
- [x] ReadLatency
- [x] WriteLatency
- [x] DBLoad
**For clusters**
- [x] AuroraVolumeBytesLeftTotal
- [x] AuroraBinlogReplicaLag | Some alarms require a `threshold` to be defined. `AuroraVolumeBytesLeftTotal` and `AuroraBinlogReplicaLag` alarms are created only for Aurora MySQL clusters. |\n| ECS | - [x] CPUUtilization
- [x] MemoryUtilization
- [x] EphemeralStorageUtilized
- [x] RunningTaskCount | The alarms are applied to `FargateService` constructs only. `EphemeralStorageUtilized` requires a `threshold` to be defined. |\n| EFS | - [x] PercentIOLimit
- [x] BurstCreditBalance | The alarms are applied to `FileSystem` constructs. |\n| ApiGateway | - [x] 4XXError
- [x] 5XXError
- [x] Count
- [x] Latency | The alarms are applied to `RestApi` constructs only. `Count` requires a `threshold` to be defined. Alarms are automatically created using the `ApiName` and `Stage` dimensions. To create `Count` or `Latency` alarms using the `Resource` and `Method` dimensions, the corresponding properties must be explicitly specified. |\n| CloudFront | - [x] 5xxErrorRate
- [x] OriginLatency
- [x] FunctionValidationErrors
- [x] FunctionExecutionErrors
- [x] FunctionThrottles | The alarms are applied to `Distribution` constructs only. Both `5xxErrorRate` and `OriginLatency` require a `threshold` to be defined. To create `Function` level alarms using the `FunctionName` dimension, the corresponding properties must be explicitly specified. |\n| DynamoDB | **Mandatory alarms**
- [x] ReadThrottleEvents
- [x] SystemErrors
- [x] WriteThrottleEvents
**Replication alarms (optional)**
- [x] AgeOfOldestUnreplicatedRecord
- [x] FailedToReplicateRecordCount
- [x] ThrottledPutRecordCount | The alarms are applied to `Table` constructs only. All the mandatory alarms require a `threshold` to be defined.
Replication alarms are created only if the corresponding configuration is specified. Each replication alarm has a default `DelegatedOperation` dimension value:
- AgeOfOldestUnreplicatedRecord: `StreamRecords`
- FailedToReplicateRecordCount: `StreamRecords`
- ThrottledPutRecordCount: `PutItem` |\n| EC2 |
- [x] CPUUtilization
- [x] StatusCheckFailed
| The alarms are applied to `Instance` constructs. |\n| AutoScaling |
- [x] GroupInServiceCapacity
| The alarms are applied to `AutoScalingGroup` constructs. The alarm requires a `threshold` to be defined and the `AutoScalingGroup` should have this metric explicitly enabled. |\n| ElastiCache |
- [x] DatabaseMemoryUsagePercentage
- [x] EngineCPUUtilization
- [x] ReplicationLag
| The alarms are applied to `CfnCacheCluster` and `CfnReplicationGroup` constructs. `DatabaseMemoryUsagePercentage` and `ReplicationLag` require a `threshold` to be defined.|\n| PrivateLink | **Endpoints**
- [x] PacketsDropped
**Endpoint Services**
- [x] RstPacketsSent
| The alarms are applied to `InterfaceVpcEndpoint` and `VpcEndpointService` constructs. Because these objects do not expose the attributes required by alarms, they cannot be implemented using the `Aspect`. In all cases, the `threshold` must be defined. |\n| VPN |
- [x] TunnelState
| The alarms are applied to `CfnVPNConnection` constructs. |\n| ELBv2 | **For ApplicationLoadBalancer**
- [x] RejectedConnectionCount
- [x] HTTPCode_ELB_4XX_Count
- [x] HTTPCode_ELB_5XX_Count
- [x] HTTPCode_Target_5XX_Count
**For ApplicationTargetGroup**
- [x] HealthyHostCount
- [x] UnHealthyHostCount
**For NetworkLoadBalancer**
- [x] TCP_ELB_Reset_Count
- [x] TCP_Target_Reset_Count
**For NetworkTargetGroup**
- [x] HealthyHostCount
- [x] UnHealthyHostCount |- For target groups, `HealthyHostCount` alarm triggers when count falls below threshold (default: 1) and `UnHealthyHostCount` alarm triggers when count exceeds threshold (default: 0). For load balancers, all alarms trigger when count exceeds threshold (default: 0).
- The `HTTPCode_ELB_4XX_Count` and `HTTPCode_ELB_5XX_Count` alarms are defined as anomaly detection alarms instead of flat counts, because there is normally a constant background of such errors. |\n| DMS | **For ReplicationInstances**
- [x] CPUUtilization
- [x] FreeableMemory
- [x] FreeStorageSpace
- [x] WriteIOPS
- [x] SwapUsage
**For Replication Tasks**
- [x] CDCLatencySource
- [x] CDCLatencyTarget | The alarms are applied to `CfnReplicationInstance` and `CfnReplicationTask` constructs. Extended versions `ReplicationInstance` and `ReplicationTask` are also available with alarm helper methods.
**Replication Instance Notes:**
- `FreeableMemory` and `FreeStorageSpace` alarms require a `threshold` to be defined.
- `SwapUsage` alarm uses anomaly detection with a fixed 5-minute period (as required by AWS CloudWatch) to detect high swap usage that may indicate memory pressure or performance issues. By default, it triggers when swap usage exceeds the upper threshold of the anomaly detection band, but the `comparisonOperator` can be configured to detect other patterns.
**Replication Task Notes:**
- Alarms are created and validated based on the `migrationType` of the ReplicationTask. CDC-related alarms can only be created for `cdc` or `full-load-and-cdc` migration types.
- CDC latency alarms (`CDCLatencySource` and `CDCLatencyTarget`) default to detecting high latency issues (threshold: 300 seconds, comparison: GREATER_THAN_THRESHOLD) which can indicate replication lag or database performance problems.
- The `CDCLatencySource` alarm monitors the gap between the last event captured from the source endpoint and current system time, while `CDCLatencyTarget` monitors the gap between a change committed to the source and the same change committed to the target. |\n\n### Aspects\n\nBelow is an example of configuring the Lambda aspect. You must configure non-defaults for alarms which is most cases is only a `threshold`. Since the aspect is applied at the `app` level it applies to both the `TestStack` and `TestStack2` lambda functions and will create all available recommended alarms for those functions. See references for additional details on Aspects which can be applied to the app, stack, or individual constructs depending on your use case.\n\n```typescript\nimport { App, Stack, Aspects, aws_lambda as lambda } from 'aws-cdk-lib';\nimport * as recommendedalarms from '@renovosolutions/cdk-library-cloudwatch-alarms';\n\nconst app = new App();\nconst stack = new Stack(app, 'TestStack', {\n env: {\n account: '123456789012',\n region: 'us-east-1',\n },\n});\n\nconst stack2 = new Stack(app, 'TestStack2', {\n env: {\n account: '123456789012',\n region: 'us-east-1',\n },\n});\n\nconst appAspects = Aspects.of(app);\n\nappAspects.add(\n new recommendedalarms.LambdaRecommendedAlarmsAspect({\n configDurationAlarm: {\n threshold: 15,\n },\n configErrorsAlarm: {\n threshold: 1,\n },\n configThrottlesAlarm: {\n threshold: 0,\n },\n }),\n);\n\nnew lambda.Function(stack, 'Lambda', {\n runtime: lambda.Runtime.NODEJS_20_X,\n handler: 'index.handler',\n code: lambda.Code.fromInline('exports.handler = async (event) => { console.log(event); }'),\n});\n\nnew lambda.Function(stack2, 'Lambda2', {\n runtime: lambda.Runtime.NODEJS_20_X,\n handler: 'index.handler',\n code: lambda.Code.fromInline('exports.handler = async (event) => { console.log(event); }'),\n});\n```\n\n### Recommended Alarm Constructs\n\nYou can also apply alarms to a specific resource using the recommended alarm construct for a given resource type. For example if you have an S3 Bucket you might do something like below. None of the S3 alarms require configuration so no config props are needed in this case:\n\n```typescript\nimport { App, Stack, Aspects, aws_s3 as s3 } from 'aws-cdk-lib';\nimport * as recommendedalarms from '@renovosolutions/cdk-library-cloudwatch-alarms';\n\nconst app = new App();\nconst stack = new Stack(app, 'TestStack', {\n env: {\n account: '123456789012',\n region: 'us-east-1',\n },\n});\n\nconst bucket = new s3.Bucket(stack, 'Bucket', {});\n\nnew recommendedalarms.S3RecommendedAlarms(stack, 'RecommendedAlarms', {\n bucket,\n});\n```\n\n### Individual Constructs\n\nYou can also apply specific alarms from their individual constructs:\n\n```typescript\nimport { App, Stack, Aspects, aws_s3 as s3 } from 'aws-cdk-lib';\nimport * as recommendedalarms from '@renovosolutions/cdk-library-cloudwatch-alarms';\n\nconst app = new App();\nconst stack = new Stack(app, 'TestStack', {\n env: {\n account: '123456789012',\n region: 'us-east-1',\n },\n});\n\nconst bucket = new s3.Bucket(stack, 'Bucket', {});\n\nnew recommendedalarms.S3Bucket5xxErrorsAlarm(stack, 'RecommendedAlarms', {\n bucket,\n threshold: 0.10,\n});\n```\n\n### Construct Extensions\n\nYou can use extended versions of the constructs you are familiar with to expose helper methods for alarms if you'd like to keep alarms more tightly coupled to specific resources.\n\n```typescript\nimport { App, Stack, Aspects, aws_s3 as s3 } from 'aws-cdk-lib';\nimport * as recommendedalarms from '@renovosolutions/cdk-library-cloudwatch-alarms';\n\nconst app = new App();\nconst stack = new Stack(app, 'TestStack', {\n env: {\n account: '123456789012',\n region: 'us-east-1',\n },\n});\n\n const bucket = new recommendedalarms.Bucket(stack, 'Bucket', {});\n\n bucket.applyRecommendedAlarms();\n```\n\n### Alarm Actions\n\nYou can apply alarm actions using the default actions on an aspect or all recommended alarms construct or you can apply individual alarm actions for helper methods of individual constructs. See below where default actions are set but an override is set for a specific alarm for the alarm action to use a different SNS topic.\n\n```typescript\nimport { App, Stack, Aspects, aws_lambda as lambda } from 'aws-cdk-lib';\nimport * as recommendedalarms from '@renovosolutions/cdk-library-cloudwatch-alarms';\n\nconst app = new App();\nconst stack = new Stack(app, 'TestStack', {\n env: {\n account: '123456789012',\n region: 'us-east-1',\n },\n});\n\nconst stack2 = new Stack(app, 'TestStack2', {\n env: {\n account: '123456789012',\n region: 'us-east-1',\n },\n});\n\nconst alarmTopic = new sns.Topic(stack, 'Topic');\nconst topicAction = new cloudwatch_actions.SnsAction(alarmTopic)\n\nconst alarmTopic2 = new sns.Topic(stack, 'Topic');\nconst topicAction2 = new cloudwatch_actions.SnsAction(alarmTopic2)\n\nconst appAspects = Aspects.of(app);\n\nappAspects.add(\n new recommendedalarms.LambdaRecommendedAlarmsAspect({\n defaultAlarmAction: topicAction,\n defaultOkAction: topicAction,\n defaultInsufficientDataAction: topicAction,\n configDurationAlarm: {\n threshold: 15,\n alarmAction: topicAction2,\n },\n configErrorsAlarm: {\n threshold: 1,\n },\n configThrottlesAlarm: {\n threshold: 0,\n },\n\n }),\n);\n\nnew lambda.Function(stack, 'Lambda', {\n runtime: lambda.Runtime.NODEJS_20_X,\n handler: 'index.handler',\n code: lambda.Code.fromInline('exports.handler = async (event) => { console.log(event); }'),\n});\n\nnew lambda.Function(stack2, 'Lambda2', {\n runtime: lambda.Runtime.NODEJS_20_X,\n handler: 'index.handler',\n code: lambda.Code.fromInline('exports.handler = async (event) => { console.log(event); }'),\n});\n```\n\n### Exclusions\n\nYou can exclude specific alarms or specific resources. Alarms use the available metrics enums and resources use the string used for a resources id. For example below Lambda1 will not have alarms created and there will be no alarm for the Duration metric for either lambda function.\n\n```typescript\nimport { App, Stack, Aspects, aws_lambda as lambda } from 'aws-cdk-lib';\nimport * as recommendedalarms from '@renovosolutions/cdk-library-cloudwatch-alarms';\n\nconst app = new App();\nconst stack = new Stack(app, 'TestStack', {\n env: {\n account: '123456789012', // not a real account\n region: 'us-east-1',\n },\n});\n\nconst appAspects = Aspects.of(app);\n\nappAspects.add(\n new recommendedalarms.LambdaRecommendedAlarmsAspect({\n excludeResources: ['Lambda1'],\n excludeAlarms: [recommendedalarms.LambdaRecommendedAlarmsMetrics.DURATION],\n configDurationAlarm: {\n threshold: 15,\n },\n configErrorsAlarm: {\n threshold: 1,\n },\n configThrottlesAlarm: {\n threshold: 0,\n },\n }),\n);\n\nnew lambda.Function(stack, 'Lambda1', {\n runtime: lambda.Runtime.NODEJS_20_X,\n handler: 'index.handler',\n code: lambda.Code.fromInline('exports.handler = async (event) => { console.log(event); }'),\n});\n\nnew lambda.Function(stack, 'Lambda2', {\n runtime: lambda.Runtime.NODEJS_20_X,\n handler: 'index.handler',\n code: lambda.Code.fromInline('exports.handler = async (event) => { console.log(event); }'),\n});\n```\n\n## References\n\n- [AWS Recommended Alarms](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html)\n- [Aspects and the AWS CDK](https://docs.aws.amazon.com/cdk/v2/guide/aspects.html)\n"
},
"repository": {
"type": "git",
"url": "https://github.com/RenovoSolutions/cdk-library-cloudwatch-alarms.git"
},
"schema": "jsii/0.10.0",
"targets": {
"dotnet": {
"namespace": "renovosolutions",
"packageId": "Renovo.AWSCDK.Cloudwatch.Alarms"
},
"js": {
"npm": "@renovosolutions/cdk-library-cloudwatch-alarms"
},
"python": {
"distName": "renovosolutions.aws-cdk-cloudwatch-alarms",
"module": "renovosolutions_recommended_cloudwatch_alarms"
}
},
"types": {
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The base properties for an alarm where default values are consistent across all alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps",
"kind": "interface",
"locationInModule": {
"filename": "src/common.ts",
"line": 10
},
"name": "AlarmBaseProps",
"properties": [
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/common.ts",
"line": 16
},
"name": "alarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/common.ts",
"line": 28
},
"name": "insufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/common.ts",
"line": 22
},
"name": "okAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/common.ts",
"line": 34
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/common:AlarmBaseProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGateway4XXErrorAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the 4XXError alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGateway4XXErrorAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 79
},
"name": "ApiGateway4XXErrorAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The threshold value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 84
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm can detect high rates of client-side errors for the API Gateway requests.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 109
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- apiName + ' - 4XXError'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 103
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 97
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"remarks": "The unit is an absolute count of errors, not a percentage.",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 91
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/apigateway:ApiGateway4XXErrorAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGateway5XXErrorAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the 5XXError alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGateway5XXErrorAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 168
},
"name": "ApiGateway5XXErrorAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The threshold value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 172
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm can detect high rates of server-side errors for the API Gateway requests.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 197
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- apiName + ' - 5XXError'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 191
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "3",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 185
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "3",
"remarks": "The unit is an absolute count of errors, not a percentage.",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 179
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/apigateway:ApiGateway5XXErrorAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayAlarmBaseConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common optional configuration for the alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayAlarmBaseConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 37
},
"name": "ApiGatewayAlarmBaseConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "Duration.minutes(1)",
"stability": "stable",
"summary": "The period over which the specified statistic is applied."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 43
},
"name": "period",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.Duration"
}
}
],
"symbolId": "src/apigateway:ApiGatewayAlarmBaseConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayCountAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the Count alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayCountAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 253
},
"name": "ApiGatewayCountAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "Set the threshold based on historical data analysis to determine what the expected\nbaseline request count for your API is. Setting the threshold at a very high value\nmight cause the alarm to be too sensitive at periods of normal and expected low traffic.\nConversely, setting it at a very low value might cause the alarm to miss anomalous\nsmaller drops in traffic volume.",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 263
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm can detect high rates of client-side errors for the API Gateway requests.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 287
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- apiName + ' - Count'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 281
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "10",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 275
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "10",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 269
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/apigateway:ApiGatewayCountAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayDetailedAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common properties for the ApiGateway alarms when monitoring resource and method dimensions."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayDetailedAlarmConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 49
},
"name": "ApiGatewayDetailedAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The alias of the resource to monitor, used as a discriminator in the alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 53
},
"name": "alias",
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The method to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 63
},
"name": "method",
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The resource to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 58
},
"name": "resource",
"type": {
"primitive": "string"
}
}
],
"symbolId": "src/apigateway:ApiGatewayDetailedAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayLatencyAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the Latency alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayLatencyAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 344
},
"name": "ApiGatewayLatencyAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm can detect when the API Gateway requests in a stage have high latency.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 382
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- apiName + ' - Latency'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 376
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 370
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 364
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "2500",
"remarks": "The suggested threshold value does not work for all API workloads. However, you can\nuse it as a starting point for the threshold. You can then choose different threshold\nvalues based on the workload and acceptable latency, performance, and SLA requirements\nfor the API. If it is acceptable for the API to have a higher latency in general, you\ncan set a higher threshold value to make the alarm less sensitive. However, if the API\nis expected to provide near real-time responses, set a lower threshold value. You can\nalso analyze historical data to determine what the expected baseline latency is for the\napplication workload and then tune the threshold value accordingly.",
"stability": "stable",
"summary": "The value in milliseconds against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 358
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/apigateway:ApiGatewayLatencyAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRecommendedAlarmsAspect": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ApiGateway",
"stability": "stable",
"summary": "Configures the recommended alarms for an ApiGateway api."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRecommendedAlarmsAspect",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 907
},
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiRecommendedAlarmsConfig"
}
}
]
},
"interfaces": [
"aws-cdk-lib.IAspect"
],
"kind": "class",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 906
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "All aspects can visit an IConstruct."
},
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 909
},
"name": "visit",
"overrides": "aws-cdk-lib.IAspect",
"parameters": [
{
"name": "node",
"type": {
"fqn": "constructs.IConstruct"
}
}
]
}
],
"name": "ApiGatewayRecommendedAlarmsAspect",
"symbolId": "src/apigateway:ApiGatewayRecommendedAlarmsAspect"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRecommendedAlarmsMetrics": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "The recommended metrics for ApiGateway alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRecommendedAlarmsMetrics",
"kind": "enum",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 13
},
"members": [
{
"docs": {
"stability": "stable",
"summary": "The number of client-side errors captured in a given period."
},
"name": "ERROR_4XX"
},
{
"docs": {
"stability": "stable",
"summary": "The number of server-side errors captured in a given period."
},
"name": "ERROR_5XX"
},
{
"docs": {
"stability": "stable",
"summary": "The total number API requests in a given period."
},
"name": "COUNT"
},
{
"docs": {
"remarks": "The latency includes the integration latency\nand other API Gateway overhead.",
"stability": "stable",
"summary": "The time (milliseconds) between when API Gateway receives a request from a client and when it returns a response to the client."
},
"name": "LATENCY"
}
],
"name": "ApiGatewayRecommendedAlarmsMetrics",
"symbolId": "src/apigateway:ApiGatewayRecommendedAlarmsMetrics"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApi4XXErrorAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This can indicate an issue in the authorization or client request parameters. It could also mean that a resource was\nremoved or a client is requesting one that doesn't exist. Consider enabling CloudWatch Logs and checking for any errors\nthat may be causing the 4XX errors. Moreover, consider enabling detailed CloudWatch metrics to view this metric per\nresource and method and narrow down the source of the errors. Errors could also be caused by exceeding the configured\nthrottling limit.\n\nThe alarm is triggered when number of client-errors exceeds the threshold.",
"stability": "stable",
"summary": "This alarm detects a high number of client-side errors."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApi4XXErrorAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 129
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApi4XXErrorAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 128
},
"name": "ApiGatewayRestApi4XXErrorAlarm",
"symbolId": "src/apigateway:ApiGatewayRestApi4XXErrorAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApi4XXErrorAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the ApiGatewayRestApi4XXErrorAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApi4XXErrorAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGateway4XXErrorAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 115
},
"name": "ApiGatewayRestApi4XXErrorAlarmProps",
"symbolId": "src/apigateway:ApiGatewayRestApi4XXErrorAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApi5XXErrorAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This can indicate that there is something wrong on the API backend, the network,\nor the integration between the API gateway and the backend API.\n\nThe alarm is triggered when number of server-errors exceeds the threshold.",
"stability": "stable",
"summary": "This alarm detects a high number of server-side errors."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApi5XXErrorAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 214
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApi5XXErrorAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 213
},
"name": "ApiGatewayRestApi5XXErrorAlarm",
"symbolId": "src/apigateway:ApiGatewayRestApi5XXErrorAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApi5XXErrorAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the ApiGatewayRestApi5XXErrorAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApi5XXErrorAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGateway5XXErrorAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 203
},
"name": "ApiGatewayRestApi5XXErrorAlarmProps",
"symbolId": "src/apigateway:ApiGatewayRestApi5XXErrorAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common properties for the ApiGateway RestApi alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiAlarmProps",
"kind": "interface",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 69
},
"name": "ApiGatewayRestApiAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The ApiGateway api to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 73
},
"name": "api",
"type": {
"fqn": "aws-cdk-lib.aws_apigateway.RestApi"
}
}
],
"symbolId": "src/apigateway:ApiGatewayRestApiAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiCountAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This can be an indicator of an issue with the application calling the API such as using incorrect endpoints.\nIt could also be an indicator of an issue with the configuration or permissions of the API making it unreachable\nfor clients.\n\nThe alarm is triggered when the number of requests in a given period is less than threshold.",
"stability": "stable",
"summary": "This alarm helps to detect low traffic volume for the REST API stage."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiCountAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 305
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiCountAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 304
},
"name": "ApiGatewayRestApiCountAlarm",
"symbolId": "src/apigateway:ApiGatewayRestApiCountAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiCountAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the ApiGatewayRestApiCountAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiCountAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayCountAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 293
},
"name": "ApiGatewayRestApiCountAlarmProps",
"symbolId": "src/apigateway:ApiGatewayRestApiCountAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiDetailedCountAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "We recommend that you create this alarm if your API receives a predictable and\nconsistent number of requests under normal conditions. This alarm is not recommended for APIs\nthat don't expect constant and consistent traffic.\n\nThe alarm is triggered when the number of requests in a given period is less than threshold.",
"stability": "stable",
"summary": "This alarm can detect unexpectedly low traffic volume for the REST API resource and method in the stage."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiDetailedCountAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 462
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiDetailedCountAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 461
},
"name": "ApiGatewayRestApiDetailedCountAlarm",
"symbolId": "src/apigateway:ApiGatewayRestApiDetailedCountAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiDetailedCountAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the Count alarm when monitoring resource and method dimensions."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiDetailedCountAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayCountAlarmConfig",
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayDetailedAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 439
},
"name": "ApiGatewayRestApiDetailedCountAlarmConfig",
"symbolId": "src/apigateway:ApiGatewayRestApiDetailedCountAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiDetailedCountAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the ApiGatewayRestApiDetailedCountAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiDetailedCountAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayCountAlarmConfig",
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayDetailedAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 446
},
"name": "ApiGatewayRestApiDetailedCountAlarmProps",
"symbolId": "src/apigateway:ApiGatewayRestApiDetailedCountAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiDetailedLatencyAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "Find the IntegrationLatency metric value to check the API backend latency. If the two\nmetrics are mostly aligned, the API backend is the source of higher latency and you should\ninvestigate there for performance issues. Consider also enabling CloudWatch Logs and checking\nfor any errors that might be causing the high latency.\n\nThe alarm is triggered when time in milliseconds exceeds or equals the threshold.",
"stability": "stable",
"summary": "This alarm detects high latency for a resource and method in a stage."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiDetailedLatencyAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 526
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiDetailedLatencyAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 525
},
"name": "ApiGatewayRestApiDetailedLatencyAlarm",
"symbolId": "src/apigateway:ApiGatewayRestApiDetailedLatencyAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiDetailedLatencyAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the Latency alarm when monitoring resource and method dimensions."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiDetailedLatencyAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayLatencyAlarmConfig",
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayDetailedAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 503
},
"name": "ApiGatewayRestApiDetailedLatencyAlarmConfig",
"symbolId": "src/apigateway:ApiGatewayRestApiDetailedLatencyAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiDetailedLatencyAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the ApiGatewayRestApiDetailedLatencyAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiDetailedLatencyAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayLatencyAlarmConfig",
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayDetailedAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 510
},
"name": "ApiGatewayRestApiDetailedLatencyAlarmProps",
"symbolId": "src/apigateway:ApiGatewayRestApiDetailedLatencyAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiLatencyAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "If you have detailed CloudWatch metrics enabled and you have different latency performance\nrequirements for each method and resource, we recommend that you create alternative alarms to\nhave more fine-grained monitoring of the latency for each resource and method.\n\nThe alarm is triggered when time in milliseconds exceeds or equals the threshold.",
"stability": "stable",
"summary": "This alarm can detect when the API Gateway requests in a stage have high latency."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiLatencyAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 400
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiLatencyAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 399
},
"name": "ApiGatewayRestApiLatencyAlarm",
"symbolId": "src/apigateway:ApiGatewayRestApiLatencyAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiLatencyAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the ApiGatewayRestApiLatencyAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiLatencyAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayLatencyAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 388
},
"name": "ApiGatewayRestApiLatencyAlarmProps",
"symbolId": "src/apigateway:ApiGatewayRestApiLatencyAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"remarks": "The recommended alarms created by default for the ApiName and Stage are:\n- 4XXError alarm\n- 5XXError alarm\n- Count alarm\n- Latency alarm\n\nIn order to create the Count or Latency alarms for the Resource and Method dimensions the\nconfigDetailedCountAlarmList or configDetailedLatencyAlarmList must be specified.",
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ApiGateway",
"stability": "stable",
"summary": "A construct that creates the recommended alarms for an ApiGateway api."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 678
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 657
},
"name": "ApiGatewayRestApiRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The 4XXError alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 661
},
"name": "alarm4XXError",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApi4XXErrorAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The 5XXError alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 666
},
"name": "alarm5XXError",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApi5XXErrorAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The Count alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 671
},
"name": "alarmCount",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiCountAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The Latency alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 676
},
"name": "alarmLatency",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiLatencyAlarm"
}
}
],
"symbolId": "src/apigateway:ApiGatewayRestApiRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "Default actions are overridden by the actions specified in the\nindividual alarm configurations.",
"stability": "stable",
"summary": "Configurations for the recommended alarms for an ApiGateway RestApi."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiRecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 570
},
"name": "ApiGatewayRestApiRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the 4XXError alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 610
},
"name": "config4XXErrorAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGateway4XXErrorAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the 5XXError alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 614
},
"name": "config5XXErrorAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGateway5XXErrorAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the Count alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 618
},
"name": "configCountAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayCountAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration list for the detailed Count alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 626
},
"name": "configDetailedCountAlarmList",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiDetailedCountAlarmConfig"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration list for the detailed Latency alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 630
},
"name": "configDetailedLatencyAlarmList",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiDetailedLatencyAlarmConfig"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the Latency alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 622
},
"name": "configLatencyAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayLatencyAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 576
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 588
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 582
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 600
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 606
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 594
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/apigateway:ApiGatewayRestApiRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the ApiGatewayRestApiRecommendedAlarms construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 636
},
"name": "ApiGatewayRestApiRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The ApiGateway api to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 640
},
"name": "api",
"type": {
"fqn": "aws-cdk-lib.aws_apigateway.RestApi"
}
}
],
"symbolId": "src/apigateway:ApiGatewayRestApiRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancer": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer",
"docs": {
"stability": "stable",
"summary": "An extension for the ApplicationLoadBalancer construct that provides methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancer",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 598
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancerProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 597
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the HTTP 4XX error count for the ApplicationLoadBalancer."
},
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 616
},
"name": "alarmHttpCode4xxCount",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode4xxCountAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode4xxCountAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the HTTP 5XX error count for the ApplicationLoadBalancer."
},
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 626
},
"name": "alarmHttpCode5xxCount",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode5xxCountAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode5xxCountAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the HTTP 5XX error count from targets for the ApplicationLoadBalancer."
},
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 636
},
"name": "alarmHttpCodeTarget5xxCount",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the rejected connection count for the ApplicationLoadBalancer."
},
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 605
},
"name": "alarmRejectedConnectionCount",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRejectedConnectionCountAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRejectedConnectionCountAlarm"
}
}
},
{
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html",
"stability": "stable",
"summary": "Creates the recommended alarms for the ApplicationLoadBalancer."
},
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 649
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRecommendedAlarms"
}
}
}
],
"name": "ApplicationLoadBalancer",
"symbolId": "src/applicationloadbalancer:ApplicationLoadBalancer"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerAlarmBaseConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common optional configuration for the alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerAlarmBaseConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 35
},
"name": "ApplicationLoadBalancerAlarmBaseConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "Duration.minutes(1)",
"stability": "stable",
"summary": "The period over which the specified statistic is applied."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 41
},
"name": "period",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.Duration"
}
}
],
"symbolId": "src/applicationloadbalancer:ApplicationLoadBalancerAlarmBaseConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common properties for the ApplicationLoadBalancer alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerAlarmProps",
"kind": "interface",
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 47
},
"name": "ApplicationLoadBalancerAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The ApplicationLoadBalancer to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 51
},
"name": "loadBalancer",
"type": {
"fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer"
}
}
],
"symbolId": "src/applicationloadbalancer:ApplicationLoadBalancerAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode4xxCountAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.AnomalyDetectionAlarm",
"docs": {
"remarks": "A high number of 4XX errors can indicate client-side issues or misconfigured requests.\n\nThe alarm is triggered when the number of 4XX errors is outside the upper threshold\nof the anomaly detection band.",
"stability": "stable",
"summary": "This anomaly detection alarm is used to detect when the load balancer is generating unusually many 4XX errors."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode4xxCountAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 197
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode4xxCountAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 196
},
"name": "ApplicationLoadBalancerHttpCode4xxCountAlarm",
"symbolId": "src/applicationloadbalancer:ApplicationLoadBalancerHttpCode4xxCountAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode4xxCountAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the HTTPCode_ELB_4XX_Count alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode4xxCountAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 146
},
"name": "ApplicationLoadBalancerHttpCode4xxCountAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect when the load balancer is generating 4XX errors.\nA high number of 4XX errors can indicate client-side issues or misconfigured requests.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 178
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- loadBalancerName + ' - HTTPCode_ELB_4XX_Count'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 171
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "3",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 159
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "3",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 153
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "8",
"stability": "stable",
"summary": "The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 165
},
"name": "stdDevs",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/applicationloadbalancer:ApplicationLoadBalancerHttpCode4xxCountAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode4xxCountAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the ApplicationLoadBalancerHttpCode4xxCountAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode4xxCountAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode4xxCountAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 184
},
"name": "ApplicationLoadBalancerHttpCode4xxCountAlarmProps",
"symbolId": "src/applicationloadbalancer:ApplicationLoadBalancerHttpCode4xxCountAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode5xxCountAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.AnomalyDetectionAlarm",
"docs": {
"remarks": "A high number of 5XX errors can indicate issues with the load balancer itself.\n\nThe alarm is triggered when the number of 5XX errors is outside the upper threshold\nof the anomaly detection band.",
"stability": "stable",
"summary": "This anomaly detection alarm is used to detect when the load balancer is generating unusually many 5XX errors."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode5xxCountAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 286
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode5xxCountAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 285
},
"name": "ApplicationLoadBalancerHttpCode5xxCountAlarm",
"symbolId": "src/applicationloadbalancer:ApplicationLoadBalancerHttpCode5xxCountAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode5xxCountAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the HTTPCode_ELB_5XX_Count alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode5xxCountAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 236
},
"name": "ApplicationLoadBalancerHttpCode5xxCountAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect when the load balancer is generating 5XX errors.\nA high number of 5XX errors can indicate issues with the load balancer itself.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 267
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- loadBalancerName + ' - HTTPCode_ELB_5XX_Count'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 254
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "3",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 248
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "3",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 242
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "8",
"stability": "stable",
"summary": "The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 260
},
"name": "stdDevs",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/applicationloadbalancer:ApplicationLoadBalancerHttpCode5xxCountAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode5xxCountAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the ApplicationLoadBalancerHttpCode5xxCountAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode5xxCountAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode5xxCountAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 273
},
"name": "ApplicationLoadBalancerHttpCode5xxCountAlarmProps",
"symbolId": "src/applicationloadbalancer:ApplicationLoadBalancerHttpCode5xxCountAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "A high number of 5XX errors can indicate issues with the application or backend services.\n\nThe alarm is triggered when the number of 5XX errors from targets is greater than threshold.",
"stability": "stable",
"summary": "This alarm is used to detect when the targets are generating 5XX errors."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 374
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 373
},
"name": "ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm",
"symbolId": "src/applicationloadbalancer:ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the HTTPCode_Target_5XX_Count alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 325
},
"name": "ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect when the targets are generating 5XX errors.\nA high number of 5XX errors can indicate issues with the application or backend services.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 357
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- loadBalancerName + ' - HTTPCode_Target_5XX_Count'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 350
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "3",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 344
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "3",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 338
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "0",
"remarks": "You should set this threshold based on the acceptable number of 5XX errors from targets.",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 332
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/applicationloadbalancer:ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 363
},
"name": "ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmProps",
"symbolId": "src/applicationloadbalancer:ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html",
"stability": "stable",
"summary": "A construct that creates the recommended alarms for an ApplicationLoadBalancer."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 508
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 487
},
"name": "ApplicationLoadBalancerRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The HTTPCode_ELB_4XX_Count alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 496
},
"name": "alarmHttpCode4xxCount",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode4xxCountAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The HTTPCode_ELB_5XX_Count alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 501
},
"name": "alarmHttpCode5xxCount",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode5xxCountAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The HTTPCode_Target_5XX_Count alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 506
},
"name": "alarmHttpCodeTarget5xxCount",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The RejectedConnectionCount alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 491
},
"name": "alarmRejectedConnectionCount",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRejectedConnectionCountAlarm"
}
}
],
"symbolId": "src/applicationloadbalancer:ApplicationLoadBalancerRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRecommendedAlarmsAspect": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html",
"stability": "stable",
"summary": "Configures the recommended alarms for an ApplicationLoadBalancer."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRecommendedAlarmsAspect",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 663
},
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRecommendedAlarmsConfig"
}
}
]
},
"interfaces": [
"aws-cdk-lib.IAspect"
],
"kind": "class",
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 662
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "All aspects can visit an IConstruct."
},
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 665
},
"name": "visit",
"overrides": "aws-cdk-lib.IAspect",
"parameters": [
{
"name": "node",
"type": {
"fqn": "constructs.IConstruct"
}
}
]
}
],
"name": "ApplicationLoadBalancerRecommendedAlarmsAspect",
"symbolId": "src/applicationloadbalancer:ApplicationLoadBalancerRecommendedAlarmsAspect"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "Default actions are overridden by the actions specified in the\nindividual alarm configurations.",
"stability": "stable",
"summary": "Configurations for the recommended alarms for an ApplicationLoadBalancer."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 417
},
"name": "ApplicationLoadBalancerRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the HTTPCode_ELB_4XX_Count alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 461
},
"name": "configHttpCode4xxCountAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode4xxCountAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the HTTPCode_ELB_5XX_Count alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 465
},
"name": "configHttpCode5xxCountAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCode5xxCountAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the HTTPCode_Target_5XX_Count alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 469
},
"name": "configHttpCodeTarget5xxCountAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the RejectedConnectionCount alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 457
},
"name": "configRejectedConnectionCountAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRejectedConnectionCountAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 423
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 435
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 429
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 447
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 453
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 441
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/applicationloadbalancer:ApplicationLoadBalancerRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRecommendedAlarmsMetrics": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "The recommended metrics for ApplicationLoadBalancer alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRecommendedAlarmsMetrics",
"kind": "enum",
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 13
},
"members": [
{
"docs": {
"stability": "stable",
"summary": "The number of connection requests that were rejected because the load balancer had reached its maximum connections."
},
"name": "REJECTED_CONNECTION_COUNT"
},
{
"docs": {
"stability": "stable",
"summary": "The number of HTTP 4XX client error codes generated by the load balancer."
},
"name": "HTTP_CODE_ELB_4XX_COUNT"
},
{
"docs": {
"stability": "stable",
"summary": "The number of HTTP 5XX server error codes generated by the load balancer."
},
"name": "HTTP_CODE_ELB_5XX_COUNT"
},
{
"docs": {
"stability": "stable",
"summary": "The number of HTTP 5XX server error codes generated by the targets."
},
"name": "HTTP_CODE_TARGET_5XX_COUNT"
}
],
"name": "ApplicationLoadBalancerRecommendedAlarmsMetrics",
"symbolId": "src/applicationloadbalancer:ApplicationLoadBalancerRecommendedAlarmsMetrics"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the ApplicationLoadBalancerRecommendedAlarms construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 475
},
"name": "ApplicationLoadBalancerRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The ApplicationLoadBalancer to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 479
},
"name": "loadBalancer",
"type": {
"fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer"
}
}
],
"symbolId": "src/applicationloadbalancer:ApplicationLoadBalancerRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRejectedConnectionCountAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "Rejected connections can indicate that the load balancer has reached its maximum connection limit.\n\nThe alarm is triggered when the number of rejected connections is greater than threshold.",
"stability": "stable",
"summary": "This alarm is used to detect when the load balancer is rejecting connections."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRejectedConnectionCountAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 106
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRejectedConnectionCountAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 105
},
"name": "ApplicationLoadBalancerRejectedConnectionCountAlarm",
"symbolId": "src/applicationloadbalancer:ApplicationLoadBalancerRejectedConnectionCountAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRejectedConnectionCountAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the RejectedConnectionCount alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRejectedConnectionCountAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 57
},
"name": "ApplicationLoadBalancerRejectedConnectionCountAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect when the load balancer is rejecting connections.\nRejected connections can indicate that the load balancer has reached its maximum connection limit.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 89
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- loadBalancerName + ' - RejectedConnectionCount'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 82
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "3",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 76
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "3",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 70
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "0",
"remarks": "You should set this threshold based on the acceptable number of rejected connections.",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 64
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/applicationloadbalancer:ApplicationLoadBalancerRejectedConnectionCountAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRejectedConnectionCountAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the ApplicationLoadBalancerRejectedConnectionCountAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRejectedConnectionCountAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationLoadBalancerRejectedConnectionCountAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/applicationloadbalancer.ts",
"line": 95
},
"name": "ApplicationLoadBalancerRejectedConnectionCountAlarmProps",
"symbolId": "src/applicationloadbalancer:ApplicationLoadBalancerRejectedConnectionCountAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroup": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup",
"docs": {
"stability": "stable",
"summary": "An extension for the ApplicationTargetGroup construct that provides methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroup",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 351
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroupProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 350
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the healthy host count for the ApplicationTargetGroup."
},
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 358
},
"name": "alarmHealthyHostCount",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupHealthyHostCountAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupHealthyHostCountAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the unhealthy host count for the ApplicationTargetGroup."
},
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 368
},
"name": "alarmUnHealthyHostCount",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupUnHealthyHostCountAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupUnHealthyHostCountAlarm"
}
}
},
{
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html",
"stability": "stable",
"summary": "Creates the recommended alarms for the ApplicationTargetGroup."
},
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 380
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupRecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupRecommendedAlarms"
}
}
}
],
"name": "ApplicationTargetGroup",
"symbolId": "src/applicationtargetgroup:ApplicationTargetGroup"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupAlarmBaseConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common optional configuration for the alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupAlarmBaseConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 27
},
"name": "ApplicationTargetGroupAlarmBaseConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "Duration.minutes(1)",
"stability": "stable",
"summary": "The period over which the specified statistic is applied."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 33
},
"name": "period",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.Duration"
}
}
],
"symbolId": "src/applicationtargetgroup:ApplicationTargetGroupAlarmBaseConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common properties for the ApplicationTargetGroup alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupAlarmProps",
"kind": "interface",
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 39
},
"name": "ApplicationTargetGroupAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The ApplicationTargetGroup to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 43
},
"name": "targetGroup",
"type": {
"fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup"
}
}
],
"symbolId": "src/applicationtargetgroup:ApplicationTargetGroupAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupHealthyHostCountAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "A low number of healthy hosts can indicate service availability issues.",
"stability": "stable",
"summary": "This alarm is used to detect when the number of healthy hosts in the target group falls below the threshold."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupHealthyHostCountAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 97
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupHealthyHostCountAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 96
},
"name": "ApplicationTargetGroupHealthyHostCountAlarm",
"symbolId": "src/applicationtargetgroup:ApplicationTargetGroupHealthyHostCountAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupHealthyHostCountAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the HealthyHostCount alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupHealthyHostCountAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 49
},
"name": "ApplicationTargetGroupHealthyHostCountAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect when the number of healthy hosts in the target group\nfalls below the threshold. A low number of healthy hosts can indicate service availability issues.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 82
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- targetGroupName + ' - HealthyHostCount'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 75
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 69
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 63
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "1",
"remarks": "You should set this threshold based on the minimum number of healthy hosts\nrequired for your application to function properly.",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 57
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/applicationtargetgroup:ApplicationTargetGroupHealthyHostCountAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupHealthyHostCountAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the ApplicationTargetGroupHealthyHostCountAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupHealthyHostCountAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupHealthyHostCountAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 88
},
"name": "ApplicationTargetGroupHealthyHostCountAlarmProps",
"symbolId": "src/applicationtargetgroup:ApplicationTargetGroupHealthyHostCountAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html",
"stability": "stable",
"summary": "A construct that creates the recommended alarms for an ApplicationTargetGroup."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 301
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 290
},
"name": "ApplicationTargetGroupRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The HealthyHostCount alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 294
},
"name": "alarmHealthyHostCount",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupHealthyHostCountAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The UnHealthyHostCount alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 299
},
"name": "alarmUnHealthyHostCount",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupUnHealthyHostCountAlarm"
}
}
],
"symbolId": "src/applicationtargetgroup:ApplicationTargetGroupRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupRecommendedAlarmsAspect": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html",
"stability": "stable",
"summary": "Configures the recommended alarms for an ApplicationTargetGroup."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupRecommendedAlarmsAspect",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 394
},
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupRecommendedAlarmsConfig"
}
}
]
},
"interfaces": [
"aws-cdk-lib.IAspect"
],
"kind": "class",
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 393
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "All aspects can visit an IConstruct."
},
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 396
},
"name": "visit",
"overrides": "aws-cdk-lib.IAspect",
"parameters": [
{
"name": "node",
"type": {
"fqn": "constructs.IConstruct"
}
}
]
}
],
"name": "ApplicationTargetGroupRecommendedAlarmsAspect",
"symbolId": "src/applicationtargetgroup:ApplicationTargetGroupRecommendedAlarmsAspect"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "Default actions are overridden by the actions specified in the\nindividual alarm configurations.",
"stability": "stable",
"summary": "Configurations for the recommended alarms for an ApplicationTargetGroup."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupRecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 228
},
"name": "ApplicationTargetGroupRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the HealthyHostCount alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 268
},
"name": "configHealthyHostCountAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupHealthyHostCountAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the UnHealthyHostCount alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 272
},
"name": "configUnHealthyHostCountAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupUnHealthyHostCountAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 234
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 246
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 240
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 258
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupRecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 264
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 252
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/applicationtargetgroup:ApplicationTargetGroupRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupRecommendedAlarmsMetrics": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "The recommended metrics for ApplicationTargetGroup alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupRecommendedAlarmsMetrics",
"kind": "enum",
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 13
},
"members": [
{
"docs": {
"stability": "stable",
"summary": "The number of healthy targets in the target group."
},
"name": "HEALTHY_HOST_COUNT"
},
{
"docs": {
"stability": "stable",
"summary": "The number of unhealthy targets in the target group."
},
"name": "UNHEALTHY_HOST_COUNT"
}
],
"name": "ApplicationTargetGroupRecommendedAlarmsMetrics",
"symbolId": "src/applicationtargetgroup:ApplicationTargetGroupRecommendedAlarmsMetrics"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the ApplicationTargetGroupRecommendedAlarms construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 278
},
"name": "ApplicationTargetGroupRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The ApplicationTargetGroup to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 282
},
"name": "targetGroup",
"type": {
"fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup"
}
}
],
"symbolId": "src/applicationtargetgroup:ApplicationTargetGroupRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupUnHealthyHostCountAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "A high number of unhealthy hosts can indicate service health issues.",
"stability": "stable",
"summary": "This alarm is used to detect when the number of unhealthy hosts in the target group exceeds the threshold."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupUnHealthyHostCountAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 185
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupUnHealthyHostCountAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 184
},
"name": "ApplicationTargetGroupUnHealthyHostCountAlarm",
"symbolId": "src/applicationtargetgroup:ApplicationTargetGroupUnHealthyHostCountAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupUnHealthyHostCountAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the UnHealthyHostCount alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupUnHealthyHostCountAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 137
},
"name": "ApplicationTargetGroupUnHealthyHostCountAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect when the number of unhealthy hosts in the target group\nexceeds the threshold. A high number of unhealthy hosts can indicate service health issues.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 170
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- targetGroupName + ' - UnHealthyHostCount'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 163
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 157
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 151
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "0",
"remarks": "You should set this threshold based on the maximum number of unhealthy hosts\nthat your application can tolerate before service is impacted.",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 145
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/applicationtargetgroup:ApplicationTargetGroupUnHealthyHostCountAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupUnHealthyHostCountAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the ApplicationTargetGroupUnHealthyHostCountAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupUnHealthyHostCountAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.ApplicationTargetGroupUnHealthyHostCountAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/applicationtargetgroup.ts",
"line": 176
},
"name": "ApplicationTargetGroupUnHealthyHostCountAlarmProps",
"symbolId": "src/applicationtargetgroup:ApplicationTargetGroupUnHealthyHostCountAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingAlarmBaseConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common optional configuration for the alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingAlarmBaseConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 23
},
"name": "AutoScalingAlarmBaseConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "Duration.minutes(1)",
"stability": "stable",
"summary": "The period over which the specified statistic is applied."
},
"immutable": true,
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 29
},
"name": "period",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.Duration"
}
}
],
"symbolId": "src/autoscaling:AutoScalingAlarmBaseConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroup": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_autoscaling.AutoScalingGroup",
"docs": {
"stability": "stable",
"summary": "An extension for the AutoScalingGroup construct that provides methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroup",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 229
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "aws-cdk-lib.aws_autoscaling.AutoScalingGroupProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 228
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the GroupInServiceCapacity for the EC2 autoScalingGroup."
},
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 236
},
"name": "alarmGroupInServiceCapacity",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupInServiceCapacityAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupGroupInServiceCapacityAlarm"
}
}
},
{
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#AutoScaling",
"stability": "stable",
"summary": "Creates the recommended alarms for the EC2 AutoScalingGroup."
},
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 248
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupRecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupRecommendedAlarms"
}
}
}
],
"name": "AutoScalingGroup",
"symbolId": "src/autoscaling:AutoScalingGroup"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common properties for the EC2 AutoScalingGroup alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupAlarmProps",
"kind": "interface",
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 35
},
"name": "AutoScalingGroupAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The EC2 AutoScalingGroup to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 39
},
"name": "autoScalingGroup",
"type": {
"fqn": "aws-cdk-lib.aws_autoscaling.AutoScalingGroup"
}
}
],
"symbolId": "src/autoscaling:AutoScalingGroupAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupGroupInServiceCapacityAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "To troubleshoot, check your scaling activities for launch failures and confirm that your desired capacity configuration\nis correct.\n\nThe alarm is triggered when the capacity in the group is less than threshold.",
"stability": "stable",
"summary": "This alarm helps to detect when the capacity in the group is below the desired capacity required for your workload."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupGroupInServiceCapacityAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 92
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupGroupInServiceCapacityAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 91
},
"name": "AutoScalingGroupGroupInServiceCapacityAlarm",
"symbolId": "src/autoscaling:AutoScalingGroupGroupInServiceCapacityAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupGroupInServiceCapacityAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the AutoScalingGroupGroupInServiceCapacityAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupGroupInServiceCapacityAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupInServiceCapacityAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 81
},
"name": "AutoScalingGroupGroupInServiceCapacityAlarmProps",
"symbolId": "src/autoscaling:AutoScalingGroupGroupInServiceCapacityAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupInServiceCapacityAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the GroupInServiceCapacity alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupInServiceCapacityAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 45
},
"name": "AutoScalingGroupInServiceCapacityAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "In most cases,\nyou can set this to match the GroupDesiredCapacity metric.",
"stability": "stable",
"summary": "The threshold value should be the minimum capacity required to run your workload."
},
"immutable": true,
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 50
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm can detect a low availability in your auto scaling group because of launch failures\nor suspended launches.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 75
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- autoScalingGroupName + ' - GroupInServiceCapacity'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 68
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "10",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 62
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "10",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 56
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/autoscaling:AutoScalingGroupInServiceCapacityAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#AutoScaling",
"stability": "stable",
"summary": "A construct that creates the recommended alarms for an EC2 AutoScalingGroup."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 199
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 193
},
"name": "AutoScalingGroupRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The GroupInServiceCapacity alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 197
},
"name": "alarmGroupInServiceCapacity",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupGroupInServiceCapacityAlarm"
}
}
],
"symbolId": "src/autoscaling:AutoScalingGroupRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "Default actions are overridden by the actions specified in the\nindividual alarm configurations.",
"stability": "stable",
"summary": "Configurations for the recommended alarms for an EC2 AutoScalingGroup."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupRecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 135
},
"name": "AutoScalingGroupRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the GroupInServiceCapacity alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 175
},
"name": "configGroupInServiceCapacityAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupInServiceCapacityAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 141
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 153
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 147
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 165
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingRecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 171
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 159
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/autoscaling:AutoScalingGroupRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the AutoScalingGroupRecommendedAlarms construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 181
},
"name": "AutoScalingGroupRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The EC2 AutoScalingGroup to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 185
},
"name": "autoScalingGroup",
"type": {
"fqn": "aws-cdk-lib.aws_autoscaling.AutoScalingGroup"
}
}
],
"symbolId": "src/autoscaling:AutoScalingGroupRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingRecommendedAlarmsAspect": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#AutoScaling",
"stability": "stable",
"summary": "Configures the recommended alarms for an EC2 AutoScalingGroup."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingRecommendedAlarmsAspect",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 262
},
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingGroupRecommendedAlarmsConfig"
}
}
]
},
"interfaces": [
"aws-cdk-lib.IAspect"
],
"kind": "class",
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 261
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "All aspects can visit an IConstruct."
},
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 264
},
"name": "visit",
"overrides": "aws-cdk-lib.IAspect",
"parameters": [
{
"name": "node",
"type": {
"fqn": "constructs.IConstruct"
}
}
]
}
],
"name": "AutoScalingRecommendedAlarmsAspect",
"symbolId": "src/autoscaling:AutoScalingRecommendedAlarmsAspect"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingRecommendedAlarmsMetrics": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "The recommended metrics for EC2 AutoScaling alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.AutoScalingRecommendedAlarmsMetrics",
"kind": "enum",
"locationInModule": {
"filename": "src/autoscaling.ts",
"line": 13
},
"members": [
{
"docs": {
"stability": "stable",
"summary": "The number of capacity units that are running as part of the Auto Scaling group."
},
"name": "GROUP_IN_SERVICE_CAPACITY"
}
],
"name": "AutoScalingRecommendedAlarmsMetrics",
"symbolId": "src/autoscaling:AutoScalingRecommendedAlarmsMetrics"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.Bucket": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_s3.Bucket",
"docs": {
"stability": "stable",
"summary": "An extension for the S3 Bucket construct that provides methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Bucket",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/s3.ts",
"line": 341
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_s3.BucketProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/s3.ts",
"line": 340
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the 4xx errors for the S3 bucket."
},
"locationInModule": {
"filename": "src/s3.ts",
"line": 348
},
"name": "alarm4xxErrors",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket4xxErrorsAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket4xxErrorsAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the 5xx errors for the S3 bucket."
},
"locationInModule": {
"filename": "src/s3.ts",
"line": 358
},
"name": "alarm5xxErrors",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket5xxErrorsAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket5xxErrorsAlarm"
}
}
},
{
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#S3",
"stability": "stable",
"summary": "Creates the recommended alarms for the S3 bucket."
},
"locationInModule": {
"filename": "src/s3.ts",
"line": 370
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3RecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3RecommendedAlarms"
}
}
}
],
"name": "Bucket",
"symbolId": "src/s3:Bucket"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CfnCacheCluster": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_elasticache.CfnCacheCluster",
"docs": {
"stability": "stable",
"summary": "An extension for the CfnCacheCluster construct that provides methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CfnCacheCluster",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 833
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "aws-cdk-lib.aws_elasticache.CfnCacheClusterProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 832
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the DatabaseMemoryUsagePercentage for the ElastiCache cacheCluster."
},
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 840
},
"name": "alarmDatabaseMemoryUsagePercentage",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the EngineCpuUtilization for the ElastiCache cacheCluster."
},
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 851
},
"name": "alarmEngineCpuUtilization",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheEngineCpuUtilizationAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterEngineCpuUtilizationAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the ReplicationLag for the ElastiCache cacheCluster."
},
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 861
},
"name": "alarmReplicationLag",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationLagAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterReplicationLagAlarm"
}
}
},
{
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ElastiCache",
"stability": "stable",
"summary": "Creates the recommended alarms for the ElastiCache CfnCacheCluster."
},
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 874
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterRecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterRecommendedAlarms"
}
}
}
],
"name": "CfnCacheCluster",
"symbolId": "src/elasticache:CfnCacheCluster"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CfnReplicationGroup": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_elasticache.CfnReplicationGroup",
"docs": {
"stability": "stable",
"summary": "An extension for the CfnReplicationGroup construct that provides methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CfnReplicationGroup",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 887
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "aws-cdk-lib.aws_elasticache.CfnReplicationGroupProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 886
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the DatabaseMemoryUsagePercentage for the ElastiCache cacheReplicationGroup."
},
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 894
},
"name": "alarmDatabaseMemoryUsagePercentage",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the EngineCpuUtilization for the ElastiCache cacheReplicationGroup."
},
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 905
},
"name": "alarmEngineCpuUtilization",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheEngineCpuUtilizationAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupEngineCpuUtilizationAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the ReplicationLag for the ElastiCache cacheReplicationGroup."
},
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 915
},
"name": "alarmReplicationLag",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationLagAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupReplicationLagAlarm"
}
}
},
{
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ElastiCache",
"stability": "stable",
"summary": "Creates the recommended alarms for the ElastiCache CfnReplicationGroup."
},
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 928
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupRecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupRecommendedAlarms"
}
}
}
],
"name": "CfnReplicationGroup",
"symbolId": "src/elasticache:CfnReplicationGroup"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFront5xxErrorRateAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the 5xxErrorRate alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFront5xxErrorRateAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 80
},
"name": "CloudFront5xxErrorRateAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "You can analyze historical data and trends, and then set the threshold\naccordingly. Because 5xx errors can be caused by transient issues, we recommend that you\nset the threshold to a value greater than 0 so that the alarm is not too sensitive.",
"stability": "stable",
"summary": "The recommended threshold value for this alarm is highly dependent on the tolerance for 5xx responses."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 87
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect problems with serving requests from the origin server,\nor problems with communication between CloudFront and your origin server.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 112
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- distributionId + ' - 5xxErrorRate'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 105
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 99
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 93
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/cloudfront:CloudFront5xxErrorRateAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontAlarmBaseConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common optional configuration for the alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontAlarmBaseConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 48
},
"name": "CloudFrontAlarmBaseConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "Duration.minutes(1)",
"stability": "stable",
"summary": "The period over which the specified statistic is applied."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 54
},
"name": "period",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.Duration"
}
}
],
"symbolId": "src/cloudfront:CloudFrontAlarmBaseConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDetailedAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common properties for the CloudFront alarms when monitoring resource and method dimensions."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDetailedAlarmConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 60
},
"name": "CloudFrontDetailedAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The name of the function to monitor, used as a discriminator in the alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 64
},
"name": "functionName",
"type": {
"primitive": "string"
}
}
],
"symbolId": "src/cloudfront:CloudFrontDetailedAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistribution5xxErrorRateAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "See {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/troubleshooting-response-errors.html Troubleshooting error responses from your origin} for information to help you understand the problems with your server.\n\nThe alarm is triggered when the percentage exceeds the threshold.",
"stability": "stable",
"summary": "This alarm monitors the percentage of 5xx error responses from your origin server, to help you detect if the CloudFront service is having issues."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistribution5xxErrorRateAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 129
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistribution5xxErrorRateAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 128
},
"name": "CloudFrontDistribution5xxErrorRateAlarm",
"symbolId": "src/cloudfront:CloudFrontDistribution5xxErrorRateAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistribution5xxErrorRateAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the CloudFrontDistribution5xxErrorRateAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistribution5xxErrorRateAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFront5xxErrorRateAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 118
},
"name": "CloudFrontDistribution5xxErrorRateAlarmProps",
"symbolId": "src/cloudfront:CloudFrontDistribution5xxErrorRateAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common properties for the CloudFront Distribution alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionAlarmProps",
"kind": "interface",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 70
},
"name": "CloudFrontDistributionAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The CloudFront Distribution to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 74
},
"name": "distribution",
"type": {
"fqn": "aws-cdk-lib.aws_cloudfront.Distribution"
}
}
],
"symbolId": "src/cloudfront:CloudFrontDistributionAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionExecutionErrorsAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "Analyze the CloudWatch function logs and look at the function code to find and resolve the root\ncause of the problem.\n\nThe alarm is triggered when the number of execution errors is greater than threshold.",
"stability": "stable",
"summary": "This alarm helps you monitor execution errors from CloudFront functions so that you can take steps to resolve them."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionExecutionErrorsAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 412
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 411
},
"name": "CloudFrontDistributionDetailedFunctionExecutionErrorsAlarm",
"symbolId": "src/cloudfront:CloudFrontDistributionDetailedFunctionExecutionErrorsAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the FunctionExecutionErrors alarm when monitoring resource and method dimensions."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontFunctionExecutionErrorsAlarmConfig",
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDetailedAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 390
},
"name": "CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmConfig",
"symbolId": "src/cloudfront:CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the CloudFrontDistributionDetailedFunctionExecutionErrorsAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontFunctionExecutionErrorsAlarmConfig",
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDetailedAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 397
},
"name": "CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmProps",
"symbolId": "src/cloudfront:CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionThrottlesAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "If your function is throttled, it means that it is taking too long to execute.\nTo avoid function throttles, consider optimizing the function code.\n\nThe alarm is triggered when the number of times the function was throttled is greater than threshold.",
"stability": "stable",
"summary": "This alarm helps you to monitor if your CloudFront function is throttled."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionThrottlesAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 510
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionThrottlesAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 509
},
"name": "CloudFrontDistributionDetailedFunctionThrottlesAlarm",
"symbolId": "src/cloudfront:CloudFrontDistributionDetailedFunctionThrottlesAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionThrottlesAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the FunctionThrottles alarm when monitoring resource and method dimensions."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionThrottlesAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontFunctionThrottlesAlarmConfig",
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDetailedAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 489
},
"name": "CloudFrontDistributionDetailedFunctionThrottlesAlarmConfig",
"symbolId": "src/cloudfront:CloudFrontDistributionDetailedFunctionThrottlesAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionThrottlesAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the CloudFrontDistributionDetailedFunctionThrottlesAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionThrottlesAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontFunctionThrottlesAlarmConfig",
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDetailedAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 496
},
"name": "CloudFrontDistributionDetailedFunctionThrottlesAlarmProps",
"symbolId": "src/cloudfront:CloudFrontDistributionDetailedFunctionThrottlesAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionValidationErrorsAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "Analyze the CloudWatch function logs and look at the function code to find and resolve the root\ncause of the problem.\n\nThe alarm is triggered when the number of validation errors is greater than threshold.",
"stability": "stable",
"summary": "This alarm helps you monitor validation errors from CloudFront functions so that you can take steps to resolve them."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionValidationErrorsAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 313
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionValidationErrorsAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 312
},
"name": "CloudFrontDistributionDetailedFunctionValidationErrorsAlarm",
"symbolId": "src/cloudfront:CloudFrontDistributionDetailedFunctionValidationErrorsAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionValidationErrorsAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the FunctionValidationErrors alarm when monitoring resource and method dimensions."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionValidationErrorsAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontFunctionValidationErrorsAlarmConfig",
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDetailedAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 291
},
"name": "CloudFrontDistributionDetailedFunctionValidationErrorsAlarmConfig",
"symbolId": "src/cloudfront:CloudFrontDistributionDetailedFunctionValidationErrorsAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionValidationErrorsAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the CloudFrontDistributionDetailedFunctionValidationErrorsAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionValidationErrorsAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontFunctionValidationErrorsAlarmConfig",
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDetailedAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 298
},
"name": "CloudFrontDistributionDetailedFunctionValidationErrorsAlarmProps",
"symbolId": "src/cloudfront:CloudFrontDistributionDetailedFunctionValidationErrorsAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionOriginLatencyAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "If the server takes too long to respond, it might lead to a timeout.\nRefer to {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/http-504-gateway-timeout.html#http-504-gateway-timeout-slow-application find and fix delayed responses from applications on your origin server}\nif you experience consistently high OriginLatency values.\n\nThe alarm is triggered when the percentage is lower or equals the threshold.",
"stability": "stable",
"summary": "The alarm helps to monitor if the origin server is taking too long to respond."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionOriginLatencyAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 214
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionOriginLatencyAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 213
},
"name": "CloudFrontDistributionOriginLatencyAlarm",
"symbolId": "src/cloudfront:CloudFrontDistributionOriginLatencyAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionOriginLatencyAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the CloudFrontDistributionOriginLatencyAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionOriginLatencyAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontOriginLatencyAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 202
},
"name": "CloudFrontDistributionOriginLatencyAlarmProps",
"symbolId": "src/cloudfront:CloudFrontDistributionOriginLatencyAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#CloudFront",
"stability": "stable",
"summary": "A construct that creates the recommended alarms for an CloudFront Distribution."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 640
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 629
},
"name": "CloudFrontDistributionRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The 5xxErrorRate alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 633
},
"name": "alarm5xxErrorRate",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistribution5xxErrorRateAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The OriginLatency alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 638
},
"name": "alarmOriginLatency",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionOriginLatencyAlarm"
}
}
],
"symbolId": "src/cloudfront:CloudFrontDistributionRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "Default actions are overridden by the actions specified in the\nindividual alarm configurations.",
"stability": "stable",
"summary": "Configurations for the recommended alarms for an CloudFront Service."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionRecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 555
},
"name": "CloudFrontDistributionRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the 5xxErrorRate alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 595
},
"name": "config5xxErrorRateAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFront5xxErrorRateAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the OriginLatency alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 599
},
"name": "configOriginLatencyAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontOriginLatencyAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration list for the detailed FunctionExecutionErrors alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 607
},
"name": "configDetailedFunctionExecutionErrorsAlarmList",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmConfig"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration list for the detailed FunctionThrottles alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 611
},
"name": "configDetailedFunctionThrottlesAlarmList",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionThrottlesAlarmConfig"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration list for the detailed FunctionValidationErrors alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 603
},
"name": "configDetailedFunctionValidationErrorsAlarmList",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionValidationErrorsAlarmConfig"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 561
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 573
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 567
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 585
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontRecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 591
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 579
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/cloudfront:CloudFrontDistributionRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the CloudFrontDistributionRecommendedAlarms construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 617
},
"name": "CloudFrontDistributionRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The CloudFront Distribution to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 621
},
"name": "distribution",
"type": {
"fqn": "aws-cdk-lib.aws_cloudfront.Distribution"
}
}
],
"symbolId": "src/cloudfront:CloudFrontDistributionRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontFunctionExecutionErrorsAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the FunctionExecutionErrors alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontFunctionExecutionErrorsAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 354
},
"name": "CloudFrontFunctionExecutionErrorsAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect execution errors from CloudFront functions.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 384
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- distributionId + ' - ' + functionName + ' - FunctionExecutionErrors'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 378
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 372
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 366
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "0",
"stability": "stable",
"summary": "We recommend to set the threshold to 0 because an execution error indicates a problem with the code that occurs at runtime."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 360
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/cloudfront:CloudFrontFunctionExecutionErrorsAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontFunctionThrottlesAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the FunctionThrottles alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontFunctionThrottlesAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 453
},
"name": "CloudFrontFunctionThrottlesAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm can detect when your CloudFront function is throttled so that you can\nreact and resolve the issue for a smooth customer experience.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 483
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- distributionId + ' - ' + functionName + ' - FunctionThrottles'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 476
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 470
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 464
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "0",
"stability": "stable",
"summary": "We recommend setting the threshold to 0, to allow quicker resolution of the function throttles."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 458
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/cloudfront:CloudFrontFunctionThrottlesAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontFunctionValidationErrorsAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the FunctionValidationErrors alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontFunctionValidationErrorsAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 251
},
"name": "CloudFrontFunctionValidationErrorsAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect validation errors from CloudFront functions.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 285
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- distributionId + ' - ' + functionName + ' - FunctionValidationErrors'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 279
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "2",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 273
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "2",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 267
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "0",
"remarks": "We recommend setting the threshold to 0 because\nvalidation errors imply a problem when CloudFront functions hand off back to CloudFront. For example,\nCloudFront needs the HTTP Host header in order to process a request. There is nothing stopping a user\nfrom deleting the Host header in their CloudFront functions code. But when CloudFront gets the response\nback and the Host header is missing, CloudFront throws a validation error.",
"stability": "stable",
"summary": "A value greater than 0 indicates a validation error."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 261
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/cloudfront:CloudFrontFunctionValidationErrorsAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontOriginLatencyAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the OriginLatency alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontOriginLatencyAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 166
},
"name": "CloudFrontOriginLatencyAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "If this metric is consistently close to the origin response timeout value,\nyou might start experiencing 504 errors.",
"stability": "stable",
"summary": "You should calculate the value of about 80% of the origin response timeout, and use the result as the threshold value."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 172
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect problems with the origin server taking too long to respond.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 196
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- distributionId + ' - OriginLatency'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 190
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 184
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 178
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/cloudfront:CloudFrontOriginLatencyAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontRecommendedAlarmsAspect": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#CloudFront",
"stability": "stable",
"summary": "Configures the recommended alarms for an CloudFront Distribution."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontRecommendedAlarmsAspect",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 856
},
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionRecommendedAlarmsConfig"
}
}
]
},
"interfaces": [
"aws-cdk-lib.IAspect"
],
"kind": "class",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 855
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "All aspects can visit an IConstruct."
},
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 858
},
"name": "visit",
"overrides": "aws-cdk-lib.IAspect",
"parameters": [
{
"name": "node",
"type": {
"fqn": "constructs.IConstruct"
}
}
]
}
],
"name": "CloudFrontRecommendedAlarmsAspect",
"symbolId": "src/cloudfront:CloudFrontRecommendedAlarmsAspect"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontRecommendedAlarmsMetrics": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "The recommended metrics for CloudFront alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontRecommendedAlarmsMetrics",
"kind": "enum",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 13
},
"members": [
{
"docs": {
"stability": "stable",
"summary": "The percentage of all viewer requests for which the response's HTTP status code is 5xx."
},
"name": "ERROR_RATE_5XX"
},
{
"docs": {
"remarks": "This is also known as first byte latency, or time-to-first-byte.",
"stability": "stable",
"summary": "The total time spent from when CloudFront receives a request to when it starts providing a response to the network (not the viewer), for requests that are served from the origin, not the CloudFront cache."
},
"name": "ORIGIN_LATENCY"
},
{
"docs": {
"remarks": "Validation errors occur when the function runs successfully but returns invalid data\n(an invalid {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/functions-event-structure.html event object}).",
"stability": "stable",
"summary": "The number of validation errors produced by the function in a given time period."
},
"name": "FUNCTION_VALIDATION_ERRORS"
},
{
"docs": {
"remarks": "Execution errors occur\nwhen the function fails to complete successfully.",
"stability": "stable",
"summary": "The number of execution errors that occurred in a given time period."
},
"name": "FUNCTION_EXECUTION_ERRORS"
},
{
"docs": {
"remarks": "Functions can be throttled for the following reasons:\n- The function continuously exceeds the maximum time allowed for execution\n- The function results in compilation errors\n- There is an unusually high number of requests per second",
"stability": "stable",
"summary": "The number of times that the function was throttled in a given time period."
},
"name": "FUNCTION_THROTTLES"
}
],
"name": "CloudFrontRecommendedAlarmsMetrics",
"symbolId": "src/cloudfront:CloudFrontRecommendedAlarmsMetrics"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DatabaseCluster": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_rds.DatabaseCluster",
"docs": {
"stability": "stable",
"summary": "An extension of the database cluster construct that provides methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DatabaseCluster",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 1576
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "aws-cdk-lib.aws_rds.DatabaseClusterProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/rds.ts",
"line": 1575
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the Bin Log Replication lag."
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 1593
},
"name": "alarmAuroraBinLogReplicationLag",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraBinLogReplicationLagAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraBinLogReplicationLagAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the AuroraVolumeBytesLeftTotal."
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 1583
},
"name": "alarmAuroraVolumeBytesLeftTotal",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraVolumeBytesLeftTotalAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraVolumeBytesLeftTotalAlarm"
}
}
},
{
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#RDS",
"stability": "stable",
"summary": "Creates recommended alarms for the database cluster."
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 1605
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraRecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraRecommendedAlarms"
}
}
}
],
"name": "DatabaseCluster",
"symbolId": "src/rds:DatabaseCluster"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DatabaseInstance": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_rds.DatabaseInstance",
"docs": {
"stability": "stable",
"summary": "An extension of the rds instance (database or cluster instance) construct that provides methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DatabaseInstance",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 1474
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "aws-cdk-lib.aws_rds.DatabaseInstanceProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/rds.ts",
"line": 1473
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the CpuUtilization."
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 1481
},
"name": "alarmCpuUtilization",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsCpuUtilizationAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceCpuUtilizationAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the DatabaseConnections."
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 1491
},
"name": "alarmDatabaseConnections",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsDatabaseConnectionsAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceDatabaseConnectionsAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the DbLoad."
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 1551
},
"name": "alarmDbLoad",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsDbLoadAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceDbLoadAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the FreeableMemory."
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 1501
},
"name": "alarmFreeableMemory",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsFreeableMemoryAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceFreeableMemoryAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the FreeLocalStorage."
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 1511
},
"name": "alarmFreeLocalStorage",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsFreeLocalStorageAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceFreeLocalStorageAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the FreeStorageSpace."
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 1521
},
"name": "alarmFreeStorageSpace",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsFreeStorageSpaceAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceFreeStorageSpaceAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the ReadLatency."
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 1531
},
"name": "alarmReadLatency",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsReadLatencyAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceReadLatencyAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the WriteLatency."
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 1541
},
"name": "alarmWriteLatency",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsWriteLatencyAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceWriteLatencyAlarm"
}
}
},
{
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#RDS",
"stability": "stable",
"summary": "Creates recommended alarms for the database instance."
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 1563
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceRecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceRecommendedAlarms"
}
}
}
],
"name": "DatabaseInstance",
"symbolId": "src/rds:DatabaseInstance"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.Distribution": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudfront.Distribution",
"docs": {
"stability": "stable",
"summary": "An extension for the Distribution construct that provides methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Distribution",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 759
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "aws-cdk-lib.aws_cloudfront.DistributionProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 758
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the 5xxErrorRate for the CloudFront distribution."
},
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 766
},
"name": "alarm5xxErrorRate",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFront5xxErrorRateAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistribution5xxErrorRateAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates a list of alarms that monitor the total number of execution errors produced by the function in a given time period."
},
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 804
},
"name": "alarmDetailedFunctionExecutionErrors",
"parameters": [
{
"name": "props",
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmConfig"
},
"kind": "array"
}
}
}
],
"returns": {
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionExecutionErrorsAlarm"
},
"kind": "array"
}
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates a list of alarms that monitor the total number of times that the function was throttled in a given time period."
},
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 822
},
"name": "alarmDetailedFunctionThrottles",
"parameters": [
{
"name": "props",
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionThrottlesAlarmConfig"
},
"kind": "array"
}
}
}
],
"returns": {
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionThrottlesAlarm"
},
"kind": "array"
}
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates a list of alarms that monitor the total number of validation errors produced by the function in a given time period."
},
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 786
},
"name": "alarmDetailedFunctionValidationErrors",
"parameters": [
{
"name": "props",
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionValidationErrorsAlarmConfig"
},
"kind": "array"
}
}
}
],
"returns": {
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionDetailedFunctionValidationErrorsAlarm"
},
"kind": "array"
}
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the OriginLatency for the CloudFront distribution."
},
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 776
},
"name": "alarmOriginLatency",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontOriginLatencyAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionOriginLatencyAlarm"
}
}
},
{
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#CloudFront",
"stability": "stable",
"summary": "Creates the recommended alarms for the CloudFront Distribution."
},
"locationInModule": {
"filename": "src/cloudfront.ts",
"line": 842
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionRecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.CloudFrontDistributionRecommendedAlarms"
}
}
}
],
"name": "Distribution",
"symbolId": "src/cloudfront:Distribution"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsAlarmBaseConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common optional configuration for the alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsAlarmBaseConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dms.ts",
"line": 76
},
"name": "DmsAlarmBaseConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "Duration.minutes(1) for regular alarms, Duration.minutes(5) for anomaly detection and throughput alarms",
"remarks": "Different alarm types may have different optimal default periods:\n- Regular alarms: 1 minute (for responsive monitoring)\n- Anomaly detection alarms: 5 minutes (for stable ML model training)\n- CDC/throughput alarms: 5 minutes (for trend analysis)",
"stability": "stable",
"summary": "The period over which the specified statistic is applied."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 87
},
"name": "period",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.Duration"
}
}
],
"symbolId": "src/dms:DmsAlarmBaseConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsAnomalyDetectionAlarmBaseConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "Anomaly detection alarms have a fixed period of 5 minutes as required by AWS CloudWatch,\nso the period property is not configurable.",
"stability": "stable",
"summary": "The common optional configuration for anomaly detection alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsAnomalyDetectionAlarmBaseConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dms.ts",
"line": 96
},
"name": "DmsAnomalyDetectionAlarmBaseConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "8 (standard deviation for anomaly detection)",
"stability": "stable",
"summary": "The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 102
},
"name": "stdDevs",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/dms:DmsAnomalyDetectionAlarmBaseConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsCdcLatencySourceAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the CdcLatencySource alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsCdcLatencySourceAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dms.ts",
"line": 587
},
"name": "DmsCdcLatencySourceAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm monitors CDC latency from the source database.\nHigh values may indicate replication lag or source database performance issues.\nThis can affect data freshness in real-time applications.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 629
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- replicationTaskIdentifier + ' - CDCLatencySource'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 621
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "GREATER_THAN_THRESHOLD (for detecting high latency issues)",
"stability": "stable",
"summary": "The comparison operator to use for the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 615
},
"name": "comparisonOperator",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.ComparisonOperator"
}
},
{
"abstract": true,
"docs": {
"default": "2 (allow for some variance while still detecting issues)",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 609
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "3 (to avoid false alarms from temporary fluctuations)",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 603
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "300 (5 minutes - for detecting high latency issues)",
"remarks": "This alarm can be used to detect:\n- High latency indicating replication lag or source database performance issues\n- Potential data freshness problems affecting real-time applications\n\nConsider your application's tolerance for data lag when setting this threshold.",
"stability": "stable",
"summary": "The latency threshold in seconds."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 597
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/dms:DmsCdcLatencySourceAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsCdcLatencyTargetAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the CdcLatencyTarget alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsCdcLatencyTargetAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dms.ts",
"line": 694
},
"name": "DmsCdcLatencyTargetAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm monitors CDC latency to the target database.\nHigh values may indicate replication lag or target database performance issues.\nThis can affect data consistency in downstream applications.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 736
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- replicationTaskIdentifier + ' - CDCLatencyTarget'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 728
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "GREATER_THAN_THRESHOLD (for detecting high latency issues)",
"stability": "stable",
"summary": "The comparison operator to use for the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 722
},
"name": "comparisonOperator",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.ComparisonOperator"
}
},
{
"abstract": true,
"docs": {
"default": "2 (allow for some variance while still detecting issues)",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 716
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "3 (to avoid false alarms from temporary fluctuations)",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 710
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "300 (5 minutes - for detecting high latency issues)",
"remarks": "This alarm can be used to detect:\n- High latency indicating target database performance issues or replication lag\n- Potential data consistency problems affecting downstream applications\n\nConsider your application's tolerance for data lag when setting this threshold.",
"stability": "stable",
"summary": "The latency threshold in seconds."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 704
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/dms:DmsCdcLatencyTargetAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsCpuUtilizationAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the CpuUtilization alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsCpuUtilizationAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dms.ts",
"line": 128
},
"name": "DmsCpuUtilizationAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect high CPU utilization for the DMS Replication\nInstance. Consistent high CPU utilization can indicate a resource bottleneck or application\nperformance problems.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 163
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- replicationInstanceIdentifier + ' - CPUUtilization'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 155
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 149
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 143
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "90",
"remarks": "The service metrics for CPU utilization might exceed 100% utilization. However,\nwe recommend that you monitor the metric for high CPU utilization to avoid impacting\nother services.",
"stability": "stable",
"summary": "The percentage (0-100) value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 137
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/dms:DmsCpuUtilizationAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsFreeStorageSpaceAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the FreeStorageSpace alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsFreeStorageSpaceAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dms.ts",
"line": 308
},
"name": "DmsFreeStorageSpaceAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "The threshold value will depend on the currently allocated storage space. Typically,\nyou should calculate the value of 10 percent of the allocated storage space and use\nthat result as the threshold value.",
"stability": "stable",
"summary": "The amount in bytes value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 315
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm helps prevent storage full issues. This can prevent downtime\nthat occurs when your replication instance runs out of storage.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 340
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- replicationInstanceIdentifier + ' - FreeStorageSpace'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 333
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 327
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 321
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/dms:DmsFreeStorageSpaceAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsFreeableMemoryAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the FreeableMemory alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsFreeableMemoryAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dms.ts",
"line": 221
},
"name": "DmsFreeableMemoryAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "Depending on the workload and instance class, different values for the threshold\ncan be appropriate. Ideally, available memory should not go below 25% of total\nmemory for prolonged periods.",
"stability": "stable",
"summary": "The amount in bytes against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 228
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm is used to help prevent running out of memory.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 252
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- replicationInstanceIdentifier + ' - FreeableMemory'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 246
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 240
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 234
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/dms:DmsFreeableMemoryAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common properties for the DMS Replication Instance alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceAlarmProps",
"kind": "interface",
"locationInModule": {
"filename": "src/dms.ts",
"line": 108
},
"name": "DmsReplicationInstanceAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The DMS Replication Instance to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 112
},
"name": "replicationInstance",
"type": {
"fqn": "aws-cdk-lib.aws_dms.CfnReplicationInstance"
}
}
],
"symbolId": "src/dms:DmsReplicationInstanceAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceCpuUtilizationAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "Consistent high CPU utilization can indicate a resource bottleneck or application\nperformance problems.\n\nThe alarm is triggered when CPU utilization exceeds % threshold.",
"stability": "stable",
"summary": "This alarm is used to detect high CPU utilization for the DMS Replication Instance."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceCpuUtilizationAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 180
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceCpuUtilizationAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/dms.ts",
"line": 179
},
"name": "DmsReplicationInstanceCpuUtilizationAlarm",
"symbolId": "src/dms:DmsReplicationInstanceCpuUtilizationAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceCpuUtilizationAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the DmsReplicationInstanceCpuUtilizationAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceCpuUtilizationAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsCpuUtilizationAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dms.ts",
"line": 169
},
"name": "DmsReplicationInstanceCpuUtilizationAlarmProps",
"symbolId": "src/dms:DmsReplicationInstanceCpuUtilizationAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceFreeStorageSpaceAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This alarm helps prevent storage full issues. This can prevent downtime that occurs when your replication\ninstance runs out of storage.\n\nThe alarm is triggered when the amount of available storage space (bytes) is less than threshold.",
"stability": "stable",
"summary": "An alarm that monitors the amount of available storage space for a DMS Replication Instance."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceFreeStorageSpaceAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 357
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceFreeStorageSpaceAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/dms.ts",
"line": 356
},
"name": "DmsReplicationInstanceFreeStorageSpaceAlarm",
"symbolId": "src/dms:DmsReplicationInstanceFreeStorageSpaceAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceFreeStorageSpaceAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the DmsReplicationInstanceFreeStorageSpaceAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceFreeStorageSpaceAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsFreeStorageSpaceAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dms.ts",
"line": 346
},
"name": "DmsReplicationInstanceFreeStorageSpaceAlarmProps",
"symbolId": "src/dms:DmsReplicationInstanceFreeStorageSpaceAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceFreeableMemoryAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This alarm is used to help prevent running out of memory.\n\nThe alarm is triggered when the percentage of available memory is less than threshold.",
"stability": "stable",
"summary": "An alarm that monitors the amount of available memory (RAM) on the replication instance."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceFreeableMemoryAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 268
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceFreeableMemoryAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/dms.ts",
"line": 267
},
"name": "DmsReplicationInstanceFreeableMemoryAlarm",
"symbolId": "src/dms:DmsReplicationInstanceFreeableMemoryAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceFreeableMemoryAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the DmsReplicationInstanceFreeableMemoryAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceFreeableMemoryAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsFreeableMemoryAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dms.ts",
"line": 258
},
"name": "DmsReplicationInstanceFreeableMemoryAlarmProps",
"symbolId": "src/dms:DmsReplicationInstanceFreeableMemoryAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"stability": "stable",
"summary": "A construct that creates the recommended alarms for a DMS Replication Instance."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 902
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/dms.ts",
"line": 876
},
"name": "DmsReplicationInstanceRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The CpuUtilization alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 880
},
"name": "alarmCpuUtilization",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceCpuUtilizationAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The FreeableMemory alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 885
},
"name": "alarmFreeableMemory",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceFreeableMemoryAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The FreeStorageSpace alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 890
},
"name": "alarmFreeStorageSpace",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceFreeStorageSpaceAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The SwapUsage alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 900
},
"name": "alarmSwapUsage",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceSwapUsageAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The WriteIops alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 895
},
"name": "alarmWriteIops",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceWriteIopsAlarm"
}
}
],
"symbolId": "src/dms:DmsReplicationInstanceRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceRecommendedAlarmsAspect": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"see": "https://aws.amazon.com/blogs/database/setting-up-amazon-cloudwatch-alarms-for-aws-dms-resources-using-the-aws-cli/",
"stability": "stable",
"summary": "Configures the recommended alarms for a DMS Replication Instance."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceRecommendedAlarmsAspect",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 1322
},
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceRecommendedAlarmsConfig"
}
}
]
},
"interfaces": [
"aws-cdk-lib.IAspect"
],
"kind": "class",
"locationInModule": {
"filename": "src/dms.ts",
"line": 1321
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "All aspects can visit an IConstruct."
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 1324
},
"name": "visit",
"overrides": "aws-cdk-lib.IAspect",
"parameters": [
{
"name": "node",
"type": {
"fqn": "constructs.IConstruct"
}
}
]
}
],
"name": "DmsReplicationInstanceRecommendedAlarmsAspect",
"symbolId": "src/dms:DmsReplicationInstanceRecommendedAlarmsAspect"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "Default actions are overridden by the actions specified in the\nindividual alarm configurations.",
"stability": "stable",
"summary": "Configurations for the recommended alarms for a DMS Replication Instance."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceRecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/dms.ts",
"line": 804
},
"name": "DmsReplicationInstanceRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the FreeableMemory alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 848
},
"name": "configFreeableMemoryAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsFreeableMemoryAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the FreeStorageSpace alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 852
},
"name": "configFreeStorageSpaceAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsFreeStorageSpaceAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the CpuUtilization alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 844
},
"name": "configCpuUtilizationAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsCpuUtilizationAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the SwapUsage alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 860
},
"name": "configSwapUsageAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsSwapUsageAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the WriteIops alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 856
},
"name": "configWriteIopsAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsWriteIopsAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 810
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 822
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 816
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 834
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceRecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 840
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 828
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/dms:DmsReplicationInstanceRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceRecommendedAlarmsMetrics": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "The recommended metrics for DMS Replication Instance alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceRecommendedAlarmsMetrics",
"kind": "enum",
"locationInModule": {
"filename": "src/dms.ts",
"line": 36
},
"members": [
{
"docs": {
"stability": "stable",
"summary": "The percentage of allocated vCPU (virtual CPU) currently in use on the instance."
},
"name": "CPU_UTILIZATION"
},
{
"docs": {
"stability": "stable",
"summary": "The amount in bytes of available random access memory."
},
"name": "FREEABLE_MEMORY"
},
{
"docs": {
"stability": "stable",
"summary": "The amount in bytes of available storage space."
},
"name": "FREE_STORAGE_SPACE"
},
{
"docs": {
"stability": "stable",
"summary": "The average number of disk write I/O operations per second."
},
"name": "WRITE_IOPS"
},
{
"docs": {
"stability": "stable",
"summary": "The amount in bytes of swap space used on the replication instance."
},
"name": "SWAP_USAGE"
}
],
"name": "DmsReplicationInstanceRecommendedAlarmsMetrics",
"symbolId": "src/dms:DmsReplicationInstanceRecommendedAlarmsMetrics"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the DmsReplicationInstanceRecommendedAlarms construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dms.ts",
"line": 866
},
"name": "DmsReplicationInstanceRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The DMS Replication Instance to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 870
},
"name": "replicationInstance",
"type": {
"fqn": "aws-cdk-lib.aws_dms.CfnReplicationInstance"
}
}
],
"symbolId": "src/dms:DmsReplicationInstanceRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceSwapUsageAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.AnomalyDetectionAlarm",
"docs": {
"remarks": "High swap usage can indicate memory pressure, performance issues, or resource constraints.\nThis alarm uses anomaly detection to identify when swap usage exceeds normal patterns,\nwhich can help identify performance degradation or insufficient memory allocation.\n\nBy default, the alarm is triggered when swap usage exceeds the upper threshold\nof the anomaly detection band, detecting unusually high swap usage that may\nindicate memory pressure or performance issues.\n\nNote: Anomaly detection alarms use a fixed 5-minute period as required by AWS CloudWatch.\nThis period cannot be customized and is optimal for anomaly detection algorithms.",
"stability": "stable",
"summary": "This anomaly detection alarm is used to detect high swap usage for the DMS Replication Instance."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceSwapUsageAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 543
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceSwapUsageAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/dms.ts",
"line": 542
},
"name": "DmsReplicationInstanceSwapUsageAlarm",
"symbolId": "src/dms:DmsReplicationInstanceSwapUsageAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceSwapUsageAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the DmsReplicationInstanceSwapUsageAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceSwapUsageAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsSwapUsageAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dms.ts",
"line": 526
},
"name": "DmsReplicationInstanceSwapUsageAlarmProps",
"symbolId": "src/dms:DmsReplicationInstanceSwapUsageAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceWriteIopsAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "High write IOPS can indicate heavy write activity or potential I/O bottlenecks.\nThis can help identify performance issues or unexpected workload patterns.\n\nThe alarm is triggered when write IOPS exceeds the specified threshold.",
"stability": "stable",
"summary": "This alarm is used to detect high write IOPS for the DMS Replication Instance."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceWriteIopsAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 448
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceWriteIopsAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/dms.ts",
"line": 447
},
"name": "DmsReplicationInstanceWriteIopsAlarm",
"symbolId": "src/dms:DmsReplicationInstanceWriteIopsAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceWriteIopsAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the DmsReplicationInstanceWriteIopsAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceWriteIopsAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsWriteIopsAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dms.ts",
"line": 437
},
"name": "DmsReplicationInstanceWriteIopsAlarmProps",
"symbolId": "src/dms:DmsReplicationInstanceWriteIopsAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common properties for the DMS Replication Task alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskAlarmProps",
"kind": "interface",
"locationInModule": {
"filename": "src/dms.ts",
"line": 118
},
"name": "DmsReplicationTaskAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The DMS Replication Task to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 122
},
"name": "replicationTask",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ReplicationTask"
}
}
],
"symbolId": "src/dms:DmsReplicationTaskAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskCdcLatencySourceAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This alarm monitors the gap between the last event captured from the source endpoint\nand current system time. It can help detect:\n- Replication lag indicating source database performance issues\n- Network connectivity problems affecting CDC capture\n- Source database load affecting change capture performance\n- Data freshness issues that could impact real-time applications\n\nThe alarm is typically configured to trigger on high latency values.",
"stability": "stable",
"summary": "An alarm that monitors the CDC latency (in seconds) from the source database."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskCdcLatencySourceAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 650
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskCdcLatencySourceAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/dms.ts",
"line": 649
},
"name": "DmsReplicationTaskCdcLatencySourceAlarm",
"symbolId": "src/dms:DmsReplicationTaskCdcLatencySourceAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskCdcLatencySourceAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the DmsReplicationTaskCdcLatencySourceAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskCdcLatencySourceAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsCdcLatencySourceAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dms.ts",
"line": 635
},
"name": "DmsReplicationTaskCdcLatencySourceAlarmProps",
"symbolId": "src/dms:DmsReplicationTaskCdcLatencySourceAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskCdcLatencyTargetAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This alarm monitors the gap between a change that was committed to the source\nand the same change committed to the target. It can help detect:\n- End-to-end replication latency affecting data consistency\n- Target database performance issues affecting write operations\n- Network connectivity problems between replication instance and target\n- Data consistency issues that could impact downstream applications\n\nThe alarm is typically configured to trigger on high latency values.",
"stability": "stable",
"summary": "An alarm that monitors the CDC latency (in seconds) to the target database."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskCdcLatencyTargetAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 757
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskCdcLatencyTargetAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/dms.ts",
"line": 756
},
"name": "DmsReplicationTaskCdcLatencyTargetAlarm",
"symbolId": "src/dms:DmsReplicationTaskCdcLatencyTargetAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskCdcLatencyTargetAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the DmsReplicationTaskCdcLatencyTargetAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskCdcLatencyTargetAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsCdcLatencyTargetAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dms.ts",
"line": 742
},
"name": "DmsReplicationTaskCdcLatencyTargetAlarmProps",
"symbolId": "src/dms:DmsReplicationTaskCdcLatencyTargetAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskMigrationType": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"remarks": "These are the valid migration types for AWS DMS Replication Tasks.",
"stability": "stable",
"summary": "DMS Replication Task migration types."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskMigrationType",
"kind": "enum",
"locationInModule": {
"filename": "src/dms.ts",
"line": 16
},
"members": [
{
"docs": {
"stability": "stable",
"summary": "Full load migration - copies all existing data from the source to the target."
},
"name": "FULL_LOAD"
},
{
"docs": {
"stability": "stable",
"summary": "Change Data Capture (CDC) migration - captures ongoing changes from the source."
},
"name": "CDC"
},
{
"docs": {
"stability": "stable",
"summary": "Full load and CDC migration - performs initial full load then captures ongoing changes."
},
"name": "FULL_LOAD_AND_CDC"
}
],
"name": "DmsReplicationTaskMigrationType",
"symbolId": "src/dms:DmsReplicationTaskMigrationType"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"stability": "stable",
"summary": "A construct that creates the recommended alarms for a DMS Replication Task."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 1096
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/dms.ts",
"line": 1085
},
"name": "DmsReplicationTaskRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The CDCLatencySource alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 1089
},
"name": "alarmCdcLatencySource",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskCdcLatencySourceAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The CDCLatencyTarget alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 1094
},
"name": "alarmCdcLatencyTarget",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskCdcLatencyTargetAlarm"
}
}
],
"symbolId": "src/dms:DmsReplicationTaskRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskRecommendedAlarmsAspect": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"see": "https://aws.amazon.com/blogs/database/setting-up-amazon-cloudwatch-alarms-for-aws-dms-resources-using-the-aws-cli/",
"stability": "stable",
"summary": "Configures the recommended alarms for a DMS Replication Task."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskRecommendedAlarmsAspect",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 1226
},
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskRecommendedAlarmsConfig"
}
}
]
},
"interfaces": [
"aws-cdk-lib.IAspect"
],
"kind": "class",
"locationInModule": {
"filename": "src/dms.ts",
"line": 1225
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "All aspects can visit an IConstruct."
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 1228
},
"name": "visit",
"overrides": "aws-cdk-lib.IAspect",
"parameters": [
{
"name": "node",
"type": {
"fqn": "constructs.IConstruct"
}
}
]
}
],
"name": "DmsReplicationTaskRecommendedAlarmsAspect",
"symbolId": "src/dms:DmsReplicationTaskRecommendedAlarmsAspect"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "Default actions are overridden by the actions specified in the\nindividual alarm configurations.",
"stability": "stable",
"summary": "Configurations for the recommended alarms for a DMS Replication Task."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskRecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/dms.ts",
"line": 1025
},
"name": "DmsReplicationTaskRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the CDCLatencySource alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 1065
},
"name": "configCdcLatencySourceAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsCdcLatencySourceAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the CDCLatencyTarget alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 1069
},
"name": "configCdcLatencyTargetAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsCdcLatencyTargetAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 1031
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 1043
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 1037
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 1055
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskRecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 1061
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 1049
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/dms:DmsReplicationTaskRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskRecommendedAlarmsMetrics": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "The recommended metrics for DMS Replication Task alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskRecommendedAlarmsMetrics",
"kind": "enum",
"locationInModule": {
"filename": "src/dms.ts",
"line": 62
},
"members": [
{
"docs": {
"stability": "stable",
"summary": "The gap, in seconds, between the last event captured from the source endpoint and current system time."
},
"name": "CDC_LATENCY_SOURCE"
},
{
"docs": {
"stability": "stable",
"summary": "The gap, in seconds, between a change that was committed to the source and the same change committed to the target."
},
"name": "CDC_LATENCY_TARGET"
}
],
"name": "DmsReplicationTaskRecommendedAlarmsMetrics",
"symbolId": "src/dms:DmsReplicationTaskRecommendedAlarmsMetrics"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the DmsReplicationTaskRecommendedAlarms construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dms.ts",
"line": 1075
},
"name": "DmsReplicationTaskRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The DMS Replication Task to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 1079
},
"name": "replicationTask",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ReplicationTask"
}
}
],
"symbolId": "src/dms:DmsReplicationTaskRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsSwapUsageAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the SwapUsage alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsSwapUsageAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsAnomalyDetectionAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dms.ts",
"line": 489
},
"name": "DmsSwapUsageAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect high swap usage for the DMS Replication Instance.\nHigh swap usage can indicate memory pressure or performance issues.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 520
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- replicationInstanceIdentifier + ' - SwapUsage'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 513
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "GREATER_THAN_UPPER_THRESHOLD (for detecting high swap usage indicating memory pressure)",
"stability": "stable",
"summary": "The comparison operator to use for the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 507
},
"name": "comparisonOperator",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.ComparisonOperator"
}
},
{
"abstract": true,
"docs": {
"default": "2 (allow for some variance while still detecting issues)",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 501
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "3 (to avoid false alarms from temporary fluctuations)",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 495
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/dms:DmsSwapUsageAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsWriteIopsAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the WriteIops alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsWriteIopsAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DmsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dms.ts",
"line": 398
},
"name": "DmsWriteIopsAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect high write IOPS for the DMS Replication\nInstance. High write IOPS can indicate heavy write activity or potential I/O bottlenecks.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 431
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- replicationInstanceIdentifier + ' - WriteIOPS'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 424
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 418
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 412
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "1000",
"remarks": "High write IOPS can indicate heavy write activity or potential performance bottlenecks.\nConsider your normal workload patterns when setting this threshold.",
"stability": "stable",
"summary": "The number of write I/O operations per second against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 406
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/dms:DmsWriteIopsAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbAgeOfOldestUnreplicatedRecordAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the AgeOfOldestUnreplicatedRecord alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbAgeOfOldestUnreplicatedRecordAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 348
},
"name": "DynamoDbAgeOfOldestUnreplicatedRecordAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "This value depends on your workload's requirements and expected performance.",
"stability": "stable",
"summary": "Set the threshold according to the desired replication delay measured in milliseconds."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 353
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm can monitor unsuccessful replication attempts and the resulting delay\nin replication to the Kinesis data stream.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 378
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- tableName + ' - AgeOfOldestUnreplicatedRecord'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 371
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "3",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 365
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "3",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 359
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/dynamodb:DynamoDbAgeOfOldestUnreplicatedRecordAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbAlarmBaseConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common optional configuration for the alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbAlarmBaseConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 47
},
"name": "DynamoDbAlarmBaseConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "Duration.minutes(1)",
"stability": "stable",
"summary": "The period over which the specified statistic is applied."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 53
},
"name": "period",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.Duration"
}
}
],
"symbolId": "src/dynamodb:DynamoDbAlarmBaseConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbFailedToReplicateRecordCountAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the FailedToReplicateRecordCount alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbFailedToReplicateRecordCountAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 444
},
"name": "DynamoDbFailedToReplicateRecordCountAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm can monitor the number of records that DynamoDB failed to replicate to\nyour Kinesis data stream because of the item size limit of Kinesis Data Streams.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 473
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- tableName + ' - FailedToReplicateRecordCount'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 466
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "1",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 460
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "1",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 454
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "Set the threshold to 0 to detect any records that DynamoDB failed to replicate."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 448
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/dynamodb:DynamoDbFailedToReplicateRecordCountAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbReadThrottleEventsAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the ReadThrottleEvents alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbReadThrottleEventsAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 69
},
"name": "DynamoDbReadThrottleEventsAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "It is important to monitor whether\nyou are under provisioned and not causing consistent throttling. You can also analyze\nhistorical data to find the acceptable throttling level for the application workload,\nand then tune the threshold to be higher than your usual throttling level. Throttled\nrequests should be retried by the application or service as they are transient. Therefore,\na very low threshold may cause the alarm to be too sensitive, causing unwanted state transitions.",
"stability": "stable",
"summary": "Set the threshold according to the expected read traffic for the DynamoDB table, accounting for an acceptable level of throttling."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 79
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm can detect sustained throttling for read requests to the DynamoDB table.\nSustained throttling of read requests can negatively impact your workload read operations and\nreduce the overall efficiency of the system.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 105
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- tableName + ' - ReadThrottleEvents'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 97
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 91
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 85
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/dynamodb:DynamoDbReadThrottleEventsAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbRecommendedAlarmsAspect": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#DynamoDB",
"stability": "stable",
"summary": "Configures the recommended alarms for an DynamoDb Table."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbRecommendedAlarmsAspect",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 974
},
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableRecommendedAlarmsConfig"
}
}
]
},
"interfaces": [
"aws-cdk-lib.IAspect"
],
"kind": "class",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 973
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "All aspects can visit an IConstruct."
},
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 976
},
"name": "visit",
"overrides": "aws-cdk-lib.IAspect",
"parameters": [
{
"name": "node",
"type": {
"fqn": "constructs.IConstruct"
}
}
]
}
],
"name": "DynamoDbRecommendedAlarmsAspect",
"symbolId": "src/dynamodb:DynamoDbRecommendedAlarmsAspect"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbRecommendedAlarmsMetrics": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "The recommended metrics for DynamoDb alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbRecommendedAlarmsMetrics",
"kind": "enum",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 13
},
"members": [
{
"docs": {
"stability": "stable",
"summary": "Requests to DynamoDB that exceed the provisioned read capacity units for a table or a global secondary index."
},
"name": "READ_THROTTLE_EVENTS"
},
{
"docs": {
"remarks": "An HTTP 500 usually indicates an internal service error.",
"stability": "stable",
"summary": "The requests to DynamoDB or Amazon DynamoDB Streams that generate an HTTP 500 status code during the specified time period."
},
"name": "SYSTEM_ERRORS"
},
{
"docs": {
"stability": "stable",
"summary": "Requests to DynamoDB that exceed the provisioned write capacity units for a table or a global secondary index."
},
"name": "WRITE_THROTTLE_EVENTS"
},
{
"docs": {
"stability": "stable",
"summary": "The elapsed time since a record yet to be replicated to the Kinesis data stream first appeared in the DynamoDB table."
},
"name": "AGE_OF_OLDEST_UNREPLICATED_RECORD"
},
{
"docs": {
"stability": "stable",
"summary": "The number of records that DynamoDB failed to replicate to your Kinesis data stream."
},
"name": "FAILED_TO_REPLICATE_RECORD_COUNT"
},
{
"docs": {
"stability": "stable",
"summary": "The number of records that were throttled by your Kinesis data stream due to insufficient Kinesis Data Streams capacity."
},
"name": "THROTTLED_PUT_RECORD_COUNT"
}
],
"name": "DynamoDbRecommendedAlarmsMetrics",
"symbolId": "src/dynamodb:DynamoDbRecommendedAlarmsMetrics"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbSystemErrorsAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the SystemErrors alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbSystemErrorsAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 162
},
"name": "DynamoDbSystemErrorsAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "You can also analyze historical data to find the acceptable error count for the application workload, and\nthen tune the threshold accordingly. System errors should be retried by the application/service as they are\ntransient. Therefore, a very low threshold might cause the alarm to be too sensitive, causing unwanted state\ntransitions.",
"stability": "stable",
"summary": "Set the threshold according to the expected traffic, accounting for an acceptable level of system errors."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 170
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm can detect sustained system errors for the DynamoDB table requests. System errors\nindicate internal service errors from DynamoDB and helps correlate to the issue that the client is having.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 195
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- tableName + ' - SystemErrors'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 188
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "15",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 182
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "15",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 176
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/dynamodb:DynamoDbSystemErrorsAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "Under normal operation, `AgeOfOldestUnreplicatedRecord` should be only milliseconds.\nThis number grows based on unsuccessful replication attempts caused by customer-controlled\nconfiguration choices. Customer-controlled configuration examples that lead to unsuccessful\nreplication attempts are an under-provisioned Kinesis data stream capacity that leads to\nexcessive throttling. or a manual update to the Kinesis data stream's access policies that\nprevents DynamoDB from adding data to the data stream. To keep this metric as low as possible,\nyou need to ensure the right provisioning of Kinesis data stream capacity and make sure that\nDynamoDB's permissions are unchanged.\n\nThe alarm is triggered when the elapsed time since a record yet to be replicated exceeds the threshold.",
"stability": "stable",
"summary": "This alarm detects the delay in replication to a Kinesis data stream."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 403
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableAgeOfOldestUnreplicatedRecordAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 402
},
"name": "DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm",
"symbolId": "src/dynamodb:DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableAgeOfOldestUnreplicatedRecordAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableAgeOfOldestUnreplicatedRecordAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbAgeOfOldestUnreplicatedRecordAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 384
},
"name": "DynamoDbTableAgeOfOldestUnreplicatedRecordAlarmProps",
"symbolId": "src/dynamodb:DynamoDbTableAgeOfOldestUnreplicatedRecordAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common properties for the DynamoDb Table alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableAlarmProps",
"kind": "interface",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 59
},
"name": "DynamoDbTableAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The DynamoDb Table to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 63
},
"name": "table",
"type": {
"fqn": "aws-cdk-lib.aws_dynamodb.Table"
}
}
],
"symbolId": "src/dynamodb:DynamoDbTableAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableFailedToReplicateRecordCountAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "Certain items larger than 34 KB might expand in size to change data records that are larger than the 1 MB\nitem size limit of Kinesis Data Streams. This size expansion occurs when these larger than 34 KB items include\na large number of Boolean or empty attribute values. Boolean and empty attribute values are stored as 1 byte\nin DynamoDB, but expand up to 5 bytes when they're serialized using standard JSON for Kinesis Data Streams\nreplication. DynamoDB can't replicate such change records to your Kinesis data stream. DynamoDB skips these\nchange data records, and automatically continues replicating subsequent records.\n\nThe alarm is triggered when the the number of records failed to be replicated exceeds the threshold.",
"stability": "stable",
"summary": "This alarm detects the number of records that DynamoDB failed to replicate to your Kinesis data stream."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableFailedToReplicateRecordCountAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 496
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableFailedToReplicateRecordCountAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 495
},
"name": "DynamoDbTableFailedToReplicateRecordCountAlarm",
"symbolId": "src/dynamodb:DynamoDbTableFailedToReplicateRecordCountAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableFailedToReplicateRecordCountAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the DynamoDbTableFailedToReplicateRecordCountAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableFailedToReplicateRecordCountAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbFailedToReplicateRecordCountAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 479
},
"name": "DynamoDbTableFailedToReplicateRecordCountAlarmProps",
"symbolId": "src/dynamodb:DynamoDbTableFailedToReplicateRecordCountAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableReadThrottleEventsAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "To troubleshoot the issue, see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TroubleshootingThrottling.html Troubleshooting throttling issues in Amazon DynamoDB}.\n\nThe alarm is triggered when the number of read requests exceeds the threshold.",
"stability": "stable",
"summary": "This alarm detects if there are high number of read requests getting throttled for the DynamoDB table."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableReadThrottleEventsAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 121
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableReadThrottleEventsAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 120
},
"name": "DynamoDbTableReadThrottleEventsAlarm",
"symbolId": "src/dynamodb:DynamoDbTableReadThrottleEventsAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableReadThrottleEventsAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the DynamoDbTableReadThrottleEventsAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableReadThrottleEventsAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbReadThrottleEventsAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 111
},
"name": "DynamoDbTableReadThrottleEventsAlarmProps",
"symbolId": "src/dynamodb:DynamoDbTableReadThrottleEventsAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#DynamoDB",
"stability": "stable",
"summary": "A construct that creates the recommended alarms for an DynamoDb Table."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 746
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 715
},
"name": "DynamoDbTableRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The AgeOfOldestUnreplicatedRecord alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 734
},
"name": "alarmAgeOfOldestUnreplicatedRecord",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The FailedToReplicateRecordCount alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 739
},
"name": "alarmFailedToReplicateRecordCount",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableFailedToReplicateRecordCountAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The ReadThrottleEvents alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 719
},
"name": "alarmReadThrottleEvents",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableReadThrottleEventsAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The SystemErrors alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 724
},
"name": "alarmSystemErrors",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableSystemErrorsAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The ThrottledPutRecordCount alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 744
},
"name": "alarmThrottledPutRecordCount",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableThrottledPutRecordCountAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The WriteThrottleEvents alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 729
},
"name": "alarmWriteThrottleEvents",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableWriteThrottleEventsAlarm"
}
}
],
"symbolId": "src/dynamodb:DynamoDbTableRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "Default actions are overridden by the actions specified in the\nindividual alarm configurations.",
"stability": "stable",
"summary": "Configurations for the recommended alarms for an DynamoDb Service."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableRecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 637
},
"name": "DynamoDbTableRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the ReadThrottleEvents alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 677
},
"name": "configReadThrottleEventsAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbReadThrottleEventsAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the SystemErrors alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 681
},
"name": "configSystemErrorsAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbSystemErrorsAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the WriteThrottleEvents alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 685
},
"name": "configWriteThrottleEventsAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbWriteThrottleEventsAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the AgeOfOldestUnreplicatedRecord alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 689
},
"name": "configAgeOfOldestUnreplicatedRecordAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbAgeOfOldestUnreplicatedRecordAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the FailedToReplicateRecordCount alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 693
},
"name": "configFailedToReplicateRecordCountAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbFailedToReplicateRecordCountAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the ThrottledPutRecordCount alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 697
},
"name": "configThrottledPutRecordCountAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbThrottledPutRecordCountAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 643
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 655
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 649
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 667
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbRecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 673
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 661
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/dynamodb:DynamoDbTableRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the DynamoDbTableRecommendedAlarms construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 703
},
"name": "DynamoDbTableRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The DynamoDb Table to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 707
},
"name": "table",
"type": {
"fqn": "aws-cdk-lib.aws_dynamodb.Table"
}
}
],
"symbolId": "src/dynamodb:DynamoDbTableRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableSystemErrorsAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "If you continue to get 5xx errors, open the {@link https://status.aws.amazon.com/ AWS Service Health Dashboard}\nto check for operational issues with the service. You can use this alarm to get notified in case there is a prolonged\ninternal service issue from DynamoDB and it helps you correlate with the issue your client application is facing.\nRefer {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.MessagesAndCodes.http5xx Error handling for DynamoDB} for more information.\n\nThe alarm is triggered when the number of system errors exceeds threshold.",
"stability": "stable",
"summary": "This alarm detects a sustained high number of system errors for the DynamoDB table requests."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableSystemErrorsAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 214
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableSystemErrorsAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 213
},
"name": "DynamoDbTableSystemErrorsAlarm",
"symbolId": "src/dynamodb:DynamoDbTableSystemErrorsAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableSystemErrorsAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the DynamoDbTableSystemErrorsAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableSystemErrorsAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbSystemErrorsAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 201
},
"name": "DynamoDbTableSystemErrorsAlarmProps",
"symbolId": "src/dynamodb:DynamoDbTableSystemErrorsAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableThrottledPutRecordCountAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This throttling happens because of insufficient Kinesis data stream capacity. If you experience excessive\nand regular throttling, you might need to increase the number of Kinesis stream shards proportionally to\nthe observed write throughput of your table. To learn more about determining the size of a Kinesis data stream,\nsee {@link https://docs.aws.amazon.com/streams/latest/dev/amazon-kinesis-streams.html#how-do-i-size-a-stream Determining the Initial Size of a Kinesis Data Stream}.\n\nThe alarm is triggered when the number or records that were throttled exceeds the threshold.",
"stability": "stable",
"summary": "This alarm detects the records getting throttled by your Kinesis data stream during the replication of change data capture to Kinesis."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableThrottledPutRecordCountAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 593
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableThrottledPutRecordCountAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 592
},
"name": "DynamoDbTableThrottledPutRecordCountAlarm",
"symbolId": "src/dynamodb:DynamoDbTableThrottledPutRecordCountAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableThrottledPutRecordCountAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the DynamoDbTableThrottledPutRecordCountAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableThrottledPutRecordCountAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbThrottledPutRecordCountAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 577
},
"name": "DynamoDbTableThrottledPutRecordCountAlarmProps",
"symbolId": "src/dynamodb:DynamoDbTableThrottledPutRecordCountAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableWriteThrottleEventsAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "To troubleshoot the issue, see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TroubleshootingThrottling.html Troubleshooting throttling issues in Amazon DynamoDB}.\n\nThe alarm is triggered when the number of read requests exceeds the threshold.",
"stability": "stable",
"summary": "This alarm detects if there are high number of read requests getting throttled for the DynamoDB table."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableWriteThrottleEventsAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 307
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableWriteThrottleEventsAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 306
},
"name": "DynamoDbTableWriteThrottleEventsAlarm",
"symbolId": "src/dynamodb:DynamoDbTableWriteThrottleEventsAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableWriteThrottleEventsAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the DynamoDbTableWriteThrottleEventsAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableWriteThrottleEventsAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbWriteThrottleEventsAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 297
},
"name": "DynamoDbTableWriteThrottleEventsAlarmProps",
"symbolId": "src/dynamodb:DynamoDbTableWriteThrottleEventsAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbThrottledPutRecordCountAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the ThrottledPutRecordCount alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbThrottledPutRecordCountAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 537
},
"name": "DynamoDbThrottledPutRecordCountAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "Set the threshold to a number which can help you\ncatch regular excessive throttling. You can also analyze historical data of this metric to find\nthe acceptable throttling rates for the application workload. Tune the threshold to a value that\nthe application can tolerate based on your use case.",
"stability": "stable",
"summary": "You might experience some throttling during exceptional usage peaks, but throttled records should remain as low as possible to avoid higher replication latency (DynamoDB retries sending throttled records to the Kinesis data stream)."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 546
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm can monitor the number of records that that were throttled by your Kinesis\ndata stream because of insufficient Kinesis data stream capacity.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 571
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- tableName + ' - ThrottledPutRecordCount'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 564
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "10",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 558
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "10",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 552
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/dynamodb:DynamoDbThrottledPutRecordCountAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbWriteThrottleEventsAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the WriteThrottleEvents alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbWriteThrottleEventsAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 254
},
"name": "DynamoDbWriteThrottleEventsAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "It is important to monitor if you\nare under provisioned and not causing consistent throttling. You can also analyze\nhistorical data to find the acceptable level of throttling for the application workload,\nand then tune the threshold to a value higher than your usual acceptable throttling level.\nThrottled requests should be retried by the application/service as they are transient.\nTherefore, a very low threshold might cause the alarm to be too sensitive, causing\nunwanted state transitions.",
"stability": "stable",
"summary": "Set the threshold according to the expected write traffic for the DynamoDB table, accounting for an acceptable level of throttling."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 265
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm can detect sustained throttling for write requests to the DynamoDB table.\nSustained throttling of write requests can negatively impact your workload write operations and\nreduce the overall efficiency of the system.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 291
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- tableName + ' - WriteThrottleEvents'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 283
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 277
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 271
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/dynamodb:DynamoDbWriteThrottleEventsAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.Ec2AlarmBaseConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common optional configuration for the alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2AlarmBaseConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/ec2.ts",
"line": 30
},
"name": "Ec2AlarmBaseConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "Duration.minutes(1)",
"stability": "stable",
"summary": "The period over which the specified statistic is applied."
},
"immutable": true,
"locationInModule": {
"filename": "src/ec2.ts",
"line": 36
},
"name": "period",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.Duration"
}
}
],
"symbolId": "src/ec2:Ec2AlarmBaseConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.Ec2CpuUtilizationAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the CPUUtilization alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2CpuUtilizationAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.Ec2AlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/ec2.ts",
"line": 52
},
"name": "Ec2CpuUtilizationAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect high CPU utilization.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ec2.ts",
"line": 87
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- instanceId + ' - CPUUtilization'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/ec2.ts",
"line": 81
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "3",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ec2.ts",
"line": 75
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "3",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/ec2.ts",
"line": 69
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "80",
"remarks": "However, you can\nadjust this value based on your acceptable performance level and workload characteristics.\nFor some systems, consistently high CPU utilization may be normal and not indicate a problem,\nwhile for others, it may be cause of concern. Analyze historical CPU utilization data to\nidentify the usage, find what CPU utilization is acceptable for your system, and set the\nthreshold accordingly.",
"stability": "stable",
"summary": "Typically, you can set the threshold for CPU utilization to 70-80%."
},
"immutable": true,
"locationInModule": {
"filename": "src/ec2.ts",
"line": 63
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/ec2:Ec2CpuUtilizationAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common properties for the EC2 Instance alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceAlarmProps",
"kind": "interface",
"locationInModule": {
"filename": "src/ec2.ts",
"line": 42
},
"name": "Ec2InstanceAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The EC2 Instance to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/ec2.ts",
"line": 46
},
"name": "instance",
"type": {
"fqn": "aws-cdk-lib.aws_ec2.Instance"
}
}
],
"symbolId": "src/ec2:Ec2InstanceAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceCpuUtilizationAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "Depending on the application, consistently high utilization levels might be normal. But if performance is degraded,\nand the application is not constrained by disk I/O, memory, or network resources, then a maxed-out CPU might indicate\na resource bottleneck or application performance problems. High CPU utilization might indicate that an upgrade to a\nmore CPU intensive instance is required. If detailed monitoring is enabled, you can change the period to 60 seconds\ninstead of 300 seconds. For more information, see Enable or turn off detailed monitoring for your instances.\n\nThe alarm is triggered when the percentage exceeds % threshold.",
"stability": "stable",
"summary": "This alarm helps to monitor the CPU utilization of an EC2 instance."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceCpuUtilizationAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/ec2.ts",
"line": 107
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceCpuUtilizationAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/ec2.ts",
"line": 106
},
"name": "Ec2InstanceCpuUtilizationAlarm",
"symbolId": "src/ec2:Ec2InstanceCpuUtilizationAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceCpuUtilizationAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the Ec2InstanceCpuUtilizationAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceCpuUtilizationAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.Ec2CpuUtilizationAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/ec2.ts",
"line": 93
},
"name": "Ec2InstanceCpuUtilizationAlarmProps",
"symbolId": "src/ec2:Ec2InstanceCpuUtilizationAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#EC2",
"stability": "stable",
"summary": "A construct that creates the recommended alarms for an EC2 Instance."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/ec2.ts",
"line": 311
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/ec2.ts",
"line": 300
},
"name": "Ec2InstanceRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The CPUUtilization alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ec2.ts",
"line": 304
},
"name": "alarmCpuUtilization",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceCpuUtilizationAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The StatusCheckFailed alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ec2.ts",
"line": 309
},
"name": "alarmStatusCheckFailed",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceStatusCheckFailedAlarm"
}
}
],
"symbolId": "src/ec2:Ec2InstanceRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "Default actions are overridden by the actions specified in the\nindividual alarm configurations.",
"stability": "stable",
"summary": "Configurations for the recommended alarms for an EC2 Service."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceRecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/ec2.ts",
"line": 238
},
"name": "Ec2InstanceRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the CPUUtilization alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ec2.ts",
"line": 278
},
"name": "configCpuUtilizationAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2CpuUtilizationAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the StatusCheckFailed alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ec2.ts",
"line": 282
},
"name": "configStatusCheckFailedAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2StatusCheckFailedAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/ec2.ts",
"line": 244
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/ec2.ts",
"line": 256
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/ec2.ts",
"line": 250
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/ec2.ts",
"line": 268
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2RecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/ec2.ts",
"line": 274
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ec2.ts",
"line": 262
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/ec2:Ec2InstanceRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the Ec2InstanceRecommendedAlarms construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/ec2.ts",
"line": 288
},
"name": "Ec2InstanceRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The EC2 Instance to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/ec2.ts",
"line": 292
},
"name": "instance",
"type": {
"fqn": "aws-cdk-lib.aws_ec2.Instance"
}
}
],
"symbolId": "src/ec2:Ec2InstanceRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceStatusCheckFailedAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "If either type of status check fails, then this alarm should be in ALARM state.\n\nThe alarm is triggered when the status reported is greater or equal to threshold.",
"stability": "stable",
"summary": "This alarm helps to monitor both system status checks and instance status checks."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceStatusCheckFailedAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/ec2.ts",
"line": 195
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceStatusCheckFailedAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/ec2.ts",
"line": 194
},
"name": "Ec2InstanceStatusCheckFailedAlarm",
"symbolId": "src/ec2:Ec2InstanceStatusCheckFailedAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceStatusCheckFailedAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the Ec2InstanceStatusCheckFailedAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceStatusCheckFailedAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.Ec2StatusCheckFailedAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/ec2.ts",
"line": 185
},
"name": "Ec2InstanceStatusCheckFailedAlarmProps",
"symbolId": "src/ec2:Ec2InstanceStatusCheckFailedAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.Ec2RecommendedAlarmsAspect": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#EC2",
"stability": "stable",
"summary": "Configures the recommended alarms for an EC2 Instance."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2RecommendedAlarmsAspect",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/ec2.ts",
"line": 404
},
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceRecommendedAlarmsConfig"
}
}
]
},
"interfaces": [
"aws-cdk-lib.IAspect"
],
"kind": "class",
"locationInModule": {
"filename": "src/ec2.ts",
"line": 403
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "All aspects can visit an IConstruct."
},
"locationInModule": {
"filename": "src/ec2.ts",
"line": 406
},
"name": "visit",
"overrides": "aws-cdk-lib.IAspect",
"parameters": [
{
"name": "node",
"type": {
"fqn": "constructs.IConstruct"
}
}
]
}
],
"name": "Ec2RecommendedAlarmsAspect",
"symbolId": "src/ec2:Ec2RecommendedAlarmsAspect"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.Ec2RecommendedAlarmsMetrics": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "The recommended metrics for EC2 alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2RecommendedAlarmsMetrics",
"kind": "enum",
"locationInModule": {
"filename": "src/ec2.ts",
"line": 13
},
"members": [
{
"docs": {
"stability": "stable",
"summary": "The percentage of physical CPU time that Amazon EC2 uses to run the EC2 instance, which includes time spent to run both the user code and the Amazon EC2 code."
},
"name": "CPU_UTILIZATION"
},
{
"docs": {
"remarks": "This metric can be either 0 (passed) or 1 (failed). By default, this metric is available at\na 1-minute frequency at no charge.",
"stability": "stable",
"summary": "Reports whether the instance has passed all status checks in the last minute."
},
"name": "STATUS_CHECK_FAILED"
}
],
"name": "Ec2RecommendedAlarmsMetrics",
"symbolId": "src/ec2:Ec2RecommendedAlarmsMetrics"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.Ec2StatusCheckFailedAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the StatusCheckFailed alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2StatusCheckFailedAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.Ec2AlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/ec2.ts",
"line": 147
},
"name": "Ec2StatusCheckFailedAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect the underlying problems with instances, including both system\nstatus check failures and instance status check failures.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ec2.ts",
"line": 179
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- instanceId + ' - StatusCheckFailed'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/ec2.ts",
"line": 172
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "2",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ec2.ts",
"line": 166
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "2",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/ec2.ts",
"line": 160
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "1",
"remarks": "The threshold is set so that whenever the\nstatus check fails, the alarm is in ALARM state.",
"stability": "stable",
"summary": "When a status check fails, the value of this metric is 1."
},
"immutable": true,
"locationInModule": {
"filename": "src/ec2.ts",
"line": 154
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/ec2:Ec2StatusCheckFailedAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsAlarmBaseConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common optional configuration for the alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsAlarmBaseConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/ecs.ts",
"line": 35
},
"name": "EcsAlarmBaseConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "Duration.minutes(1)",
"stability": "stable",
"summary": "The period over which the specified statistic is applied."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 41
},
"name": "period",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.Duration"
}
}
],
"symbolId": "src/ecs:EcsAlarmBaseConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsCpuUtilizationAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the CpuUtilization alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsCpuUtilizationAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/ecs.ts",
"line": 57
},
"name": "EcsCpuUtilizationAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect high CPU utilization for the ECS service.\nConsistent high CPU utilization can indicate a resource bottleneck or application\nperformance problems.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 93
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- clusterName + ' - ' + serviceName + ' - CPUUtilization'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 85
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 79
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 73
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "90",
"remarks": "The service metrics for CPU utilization might exceed 100% utilization. However,\nwe recommend that you monitor the metric for high CPU utilization to avoid impacting\nother services. Set the threshold to about 90-95%. We recommend that you update your\ntask definitions to reflect actual usage to prevent future issues with other services.",
"stability": "stable",
"summary": "The percentage (0-100) value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 67
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/ecs:EcsCpuUtilizationAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsEphemeralStorageUtilizedAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the EphemeralStorageUtilized alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsEphemeralStorageUtilizedAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/ecs.ts",
"line": 230
},
"name": "EcsEphemeralStorageUtilizedAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "Set the threshold to about 90% of the ephemeral storage size. You can adjust this\nvalue based on your acceptable ephemeral storage utilization of the Fargate cluster.\nFor some systems, a consistently high ephemeral storage utilized might be normal,\nwhile for others, it might lead to failure of the container.",
"stability": "stable",
"summary": "The value in GB against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 239
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect high ephemeral storage usage for the Fargate cluster.\nConsistent high ephemeral storage utilized can indicate that the disk is full and it might\nlead to failure of the container.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 265
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- clusterName + ' - ' + serviceName + ' - EphemeralStorageUtilized'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 257
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 251
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 245
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/ecs:EcsEphemeralStorageUtilizedAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsMemoryUtilizationAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the MemoryUtilization alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsMemoryUtilizationAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/ecs.ts",
"line": 144
},
"name": "EcsMemoryUtilizationAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect high memory utilization for the ECS service.\nConsistent high memory utilization can indicate a resource bottleneck or application\nperformance problems.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 179
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- clusterName + ' - ' + serviceName + ' - MemoryUtilization'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 171
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 165
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 159
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "90",
"remarks": "The memory utilization is measured as the total memory in use by the tasks that\nbelong to the service, divided by the total memory reserved for the tasks that\nbelong to the service.",
"stability": "stable",
"summary": "The percentage (0-100) value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 153
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/ecs:EcsMemoryUtilizationAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsRecommendedAlarmsAspect": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ECS",
"stability": "stable",
"summary": "Configures the recommended alarms for an ECS service."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsRecommendedAlarmsAspect",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/ecs.ts",
"line": 665
},
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceRecommendedAlarmsConfig"
}
}
]
},
"interfaces": [
"aws-cdk-lib.IAspect"
],
"kind": "class",
"locationInModule": {
"filename": "src/ecs.ts",
"line": 664
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "All aspects can visit an IConstruct."
},
"locationInModule": {
"filename": "src/ecs.ts",
"line": 667
},
"name": "visit",
"overrides": "aws-cdk-lib.IAspect",
"parameters": [
{
"name": "node",
"type": {
"fqn": "constructs.IConstruct"
}
}
]
}
],
"name": "EcsRecommendedAlarmsAspect",
"symbolId": "src/ecs:EcsRecommendedAlarmsAspect"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsRecommendedAlarmsMetrics": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "The recommended metrics for ECS alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsRecommendedAlarmsMetrics",
"kind": "enum",
"locationInModule": {
"filename": "src/ecs.ts",
"line": 13
},
"members": [
{
"docs": {
"stability": "stable",
"summary": "The percentage of CPU units that is used by the cluster or service."
},
"name": "CPU_UTILIZATION"
},
{
"docs": {
"stability": "stable",
"summary": "The percentage of memory in use by the cluster or service."
},
"name": "MEMORY_UTILIZATION"
},
{
"docs": {
"stability": "stable",
"summary": "The ephemeral storage in GB that is used by the cluster or service."
},
"name": "EPHEMERAL_STORAGE_UTILIZED"
},
{
"docs": {
"stability": "stable",
"summary": "The number of tasks in your services that are in the RUNNING state."
},
"name": "RUNNING_TASK_COUNT"
}
],
"name": "EcsRecommendedAlarmsMetrics",
"symbolId": "src/ecs:EcsRecommendedAlarmsMetrics"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsRunningTaskCountAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the RunningTaskCount alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsRunningTaskCountAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/ecs.ts",
"line": 324
},
"name": "EcsRunningTaskCountAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect whether the number of running tasks are too low.\nA consistent low running task count can indicate ECS service deployment or performance issues.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 357
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- clusterName + ' - ' + serviceName + ' - RunningTaskCount'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 350
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 344
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 338
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "0",
"remarks": "You can adjust the threshold based on the minimum running task count of the ECS\nservice. If the running task count is 0, the Amazon ECS service will be unavailable.",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 332
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/ecs:EcsRunningTaskCountAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common properties for the ECS service alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceAlarmProps",
"kind": "interface",
"locationInModule": {
"filename": "src/ecs.ts",
"line": 47
},
"name": "EcsServiceAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The ECS service to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 51
},
"name": "service",
"type": {
"fqn": "aws-cdk-lib.aws_ecs.FargateService"
}
}
],
"symbolId": "src/ecs:EcsServiceAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceCpuUtilizationAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "Consistent high CPU utilization can indicate a resource bottleneck or\napplication performance problems.\n\nThe alarm is triggered when CPU utilization exceeds % threshold.",
"stability": "stable",
"summary": "This alarm is used to detect high CPU utilization for the ECS service."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceCpuUtilizationAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/ecs.ts",
"line": 110
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceCpuUtilizationAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/ecs.ts",
"line": 109
},
"name": "EcsServiceCpuUtilizationAlarm",
"symbolId": "src/ecs:EcsServiceCpuUtilizationAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceCpuUtilizationAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the EcsServiceCpuUtilizationAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceCpuUtilizationAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsCpuUtilizationAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/ecs.ts",
"line": 99
},
"name": "EcsServiceCpuUtilizationAlarmProps",
"symbolId": "src/ecs:EcsServiceCpuUtilizationAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceEphemeralStorageUtilizedAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "Consistent high ephemeral storage utilized can indicate that the disk is full and it\nmight lead to failure of the container.\n\nThe alarm is triggered when the storage utilized (GB) exceeds the threshold.",
"stability": "stable",
"summary": "This alarm is used to detect high ephemeral storage usage for the Fargate cluster."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceEphemeralStorageUtilizedAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/ecs.ts",
"line": 282
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceEphemeralStorageUtilizedAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/ecs.ts",
"line": 281
},
"name": "EcsServiceEphemeralStorageUtilizedAlarm",
"symbolId": "src/ecs:EcsServiceEphemeralStorageUtilizedAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceEphemeralStorageUtilizedAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the EcsServiceEphemeralStorageUtilizedAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceEphemeralStorageUtilizedAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsEphemeralStorageUtilizedAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/ecs.ts",
"line": 271
},
"name": "EcsServiceEphemeralStorageUtilizedAlarmProps",
"symbolId": "src/ecs:EcsServiceEphemeralStorageUtilizedAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceMemoryUtilizationAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "Consistent high memory utilization can indicate a resource bottleneck or\napplication performance problems.\n\nThe alarm is triggered when memory utilization exceeds % threshold.",
"stability": "stable",
"summary": "This alarm is used to detect high memory utilization for the ECS service."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceMemoryUtilizationAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/ecs.ts",
"line": 196
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceMemoryUtilizationAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/ecs.ts",
"line": 195
},
"name": "EcsServiceMemoryUtilizationAlarm",
"symbolId": "src/ecs:EcsServiceMemoryUtilizationAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceMemoryUtilizationAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the EcsServiceMemoryUtilizationAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceMemoryUtilizationAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsMemoryUtilizationAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/ecs.ts",
"line": 185
},
"name": "EcsServiceMemoryUtilizationAlarmProps",
"symbolId": "src/ecs:EcsServiceMemoryUtilizationAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ECS",
"stability": "stable",
"summary": "A construct that creates the recommended alarms for an ECS service."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/ecs.ts",
"line": 512
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/ecs.ts",
"line": 491
},
"name": "EcsServiceRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The CpuUtilization alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 495
},
"name": "alarmCpuUtilization",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceCpuUtilizationAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The EphemeralStorageUtilized alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 505
},
"name": "alarmEphemeralStorageUtilized",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceEphemeralStorageUtilizedAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The MemoryUtilization alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 500
},
"name": "alarmMemoryUtilization",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceMemoryUtilizationAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The RunningTaskCount alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 510
},
"name": "alarmRunningTaskCount",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceRunningTaskCountAlarm"
}
}
],
"symbolId": "src/ecs:EcsServiceRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "Default actions are overridden by the actions specified in the\nindividual alarm configurations.",
"stability": "stable",
"summary": "Configurations for the recommended alarms for an ECS Service."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceRecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/ecs.ts",
"line": 421
},
"name": "EcsServiceRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the EphemeralStorageUtilized alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 469
},
"name": "configEphemeralStorageUtilizedAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsEphemeralStorageUtilizedAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the CpuUtilization alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 461
},
"name": "configCpuUtilizationAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsCpuUtilizationAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the MemoryUtilization alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 465
},
"name": "configMemoryUtilizationAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsMemoryUtilizationAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the RunningTaskCount alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 473
},
"name": "configRunningTaskCountAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsRunningTaskCountAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 427
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 439
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 433
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 451
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsRecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 457
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 445
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/ecs:EcsServiceRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the EcsServiceRecommendedAlarms construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/ecs.ts",
"line": 479
},
"name": "EcsServiceRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The ECS service to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/ecs.ts",
"line": 483
},
"name": "service",
"type": {
"fqn": "aws-cdk-lib.aws_ecs.FargateService"
}
}
],
"symbolId": "src/ecs:EcsServiceRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceRunningTaskCountAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "If the running task count is too low, it can can indicate that the application\ncan’t handle the service load and it might lead to performance issues. If there\nis no running task, the Amazon ECS service might be unavailable or there might\nbe deployment issues.\n\nThe alarm is triggered when the number of running tasks is less than or equal to\nthreshold.",
"stability": "stable",
"summary": "This alarm helps you detect a low running task count of the ECS service."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceRunningTaskCountAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/ecs.ts",
"line": 377
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceRunningTaskCountAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/ecs.ts",
"line": 376
},
"name": "EcsServiceRunningTaskCountAlarm",
"symbolId": "src/ecs:EcsServiceRunningTaskCountAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceRunningTaskCountAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the EcsServiceRunningTaskCountAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceRunningTaskCountAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.EcsRunningTaskCountAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/ecs.ts",
"line": 363
},
"name": "EcsServiceRunningTaskCountAlarmProps",
"symbolId": "src/ecs:EcsServiceRunningTaskCountAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EfsAlarmBaseConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common optional configuration for the alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsAlarmBaseConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/efs.ts",
"line": 29
},
"name": "EfsAlarmBaseConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "Duration.minutes(1)",
"stability": "stable",
"summary": "The period over which the specified statistic is applied."
},
"immutable": true,
"locationInModule": {
"filename": "src/efs.ts",
"line": 35
},
"name": "period",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.Duration"
}
}
],
"symbolId": "src/efs:EfsAlarmBaseConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EfsBurstCreditBalanceAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the BurstCreditBalance alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsBurstCreditBalanceAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.EfsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/efs.ts",
"line": 148
},
"name": "EfsBurstCreditBalanceAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect low burst credit balance of the file system. Consistent low\nburst credit balance can be an indicator of the slowing down in throughput and increase in I/O latency.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/efs.ts",
"line": 182
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- fileSystemId + ' - BurstCreditBalance'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/efs.ts",
"line": 175
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "15",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/efs.ts",
"line": 169
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "15",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/efs.ts",
"line": 163
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "0",
"remarks": "However, it is recommended\nthat the metric is monitored for low burst credit balance to avoid the file system acting as resource\nbottleneck for the applications. The threshold can be set around 0 bytes.",
"stability": "stable",
"summary": "When the file system run out of burst credits and even if the baseline throughput rate is lower, EFS continues to provide a metered throughput of 1 MiBps to all file systems."
},
"immutable": true,
"locationInModule": {
"filename": "src/efs.ts",
"line": 157
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/efs:EfsBurstCreditBalanceAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common properties for the EFS FileSystem alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemAlarmProps",
"kind": "interface",
"locationInModule": {
"filename": "src/efs.ts",
"line": 41
},
"name": "EfsFileSystemAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The EFS FileSystem to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/efs.ts",
"line": 45
},
"name": "fileSystem",
"type": {
"fqn": "aws-cdk-lib.aws_efs.FileSystem"
}
}
],
"symbolId": "src/efs:EfsFileSystemAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemBurstCreditBalanceAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "When there is no available burst credit, applications access to the the file system will be limited due to low throughput.\nIf the metric drops to 0 consistently, consider changing the throughput mode to Elastic or Provisioned throughput mode.\n\nThe alarm is triggered when the percentage is lower or equals the threshold.",
"stability": "stable",
"summary": "This alarm helps in ensuring that there is available burst credit balance for the file system usage."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemBurstCreditBalanceAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/efs.ts",
"line": 199
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemBurstCreditBalanceAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/efs.ts",
"line": 198
},
"name": "EfsFileSystemBurstCreditBalanceAlarm",
"symbolId": "src/efs:EfsFileSystemBurstCreditBalanceAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemBurstCreditBalanceAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the EfsFileSystemBurstCreditBalanceAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemBurstCreditBalanceAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.EfsBurstCreditBalanceAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/efs.ts",
"line": 188
},
"name": "EfsFileSystemBurstCreditBalanceAlarmProps",
"symbolId": "src/efs:EfsFileSystemBurstCreditBalanceAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemPercentIOLimitAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "If the metric reaches its I/O limit consistently, consider moving the application to a file system that\nuses Max I/O performance as mode. For troubleshooting, check clients that are connected to the file system\nand applications of the clients that throttles the file system.\n\nThe alarm is triggered when the percentage exceed or equals % threshold.",
"stability": "stable",
"summary": "This alarm helps in ensuring that the workload stays within the I/O limit available to the file system."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemPercentIOLimitAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/efs.ts",
"line": 105
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemPercentIOLimitAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/efs.ts",
"line": 104
},
"name": "EfsFileSystemPercentIOLimitAlarm",
"symbolId": "src/efs:EfsFileSystemPercentIOLimitAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemPercentIOLimitAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the EfsFileSystemPercentIOLimitAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemPercentIOLimitAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.EfsPercentIOLimitAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/efs.ts",
"line": 93
},
"name": "EfsFileSystemPercentIOLimitAlarmProps",
"symbolId": "src/efs:EfsFileSystemPercentIOLimitAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#EFS",
"stability": "stable",
"summary": "A construct that creates the recommended alarms for an EFS FileSystem."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/efs.ts",
"line": 315
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/efs.ts",
"line": 304
},
"name": "EfsFileSystemRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The BurstCreditBalance alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/efs.ts",
"line": 313
},
"name": "alarmBurstCreditBalance",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemBurstCreditBalanceAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The PercentIOLimit alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/efs.ts",
"line": 308
},
"name": "alarmPercentIOLimit",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemPercentIOLimitAlarm"
}
}
],
"symbolId": "src/efs:EfsFileSystemRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "Default actions are overridden by the actions specified in the\nindividual alarm configurations.",
"stability": "stable",
"summary": "Configurations for the recommended alarms for an EFS Service."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemRecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/efs.ts",
"line": 242
},
"name": "EfsFileSystemRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the BurstCreditBalance alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/efs.ts",
"line": 286
},
"name": "configBurstCreditBalanceAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsBurstCreditBalanceAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the PercentIOLimit alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/efs.ts",
"line": 282
},
"name": "configPercentIOLimitAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsPercentIOLimitAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/efs.ts",
"line": 248
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/efs.ts",
"line": 260
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/efs.ts",
"line": 254
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/efs.ts",
"line": 272
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsRecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/efs.ts",
"line": 278
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/efs.ts",
"line": 266
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/efs:EfsFileSystemRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the EfsFileSystemRecommendedAlarms construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/efs.ts",
"line": 292
},
"name": "EfsFileSystemRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The EFS FileSystem to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/efs.ts",
"line": 296
},
"name": "fileSystem",
"type": {
"fqn": "aws-cdk-lib.aws_efs.FileSystem"
}
}
],
"symbolId": "src/efs:EfsFileSystemRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EfsPercentIOLimitAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the PercentIOLimit alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsPercentIOLimitAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.EfsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/efs.ts",
"line": 51
},
"name": "EfsPercentIOLimitAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect how close the file system is to reach the I/O limit of the General\nPurpose performance mode. Consistent high I/O percentage can be an indicator of the file system cannot scale\nwith respect to I/O requests enough and the file system can be a resource bottleneck for the applications\nthat use the file system.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/efs.ts",
"line": 87
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- fileSystemId + ' - PercentIOLimit'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/efs.ts",
"line": 78
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "15",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/efs.ts",
"line": 72
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "15",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/efs.ts",
"line": 66
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "100",
"remarks": "Therefore, it is recommended that the metric is monitored to avoid impacting applications that\nuse the file system. The threshold can be set around 100%. However, this value can be adjusted\nto a lower value based on file system characteristics.",
"stability": "stable",
"summary": "When the file system reaches its I/O limit, it may respond to read and write requests slower."
},
"immutable": true,
"locationInModule": {
"filename": "src/efs.ts",
"line": 60
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/efs:EfsPercentIOLimitAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EfsRecommendedAlarmsAspect": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#EFS",
"stability": "stable",
"summary": "Configures the recommended alarms for an EFS FileSystem."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsRecommendedAlarmsAspect",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/efs.ts",
"line": 408
},
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemRecommendedAlarmsConfig"
}
}
]
},
"interfaces": [
"aws-cdk-lib.IAspect"
],
"kind": "class",
"locationInModule": {
"filename": "src/efs.ts",
"line": 407
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "All aspects can visit an IConstruct."
},
"locationInModule": {
"filename": "src/efs.ts",
"line": 410
},
"name": "visit",
"overrides": "aws-cdk-lib.IAspect",
"parameters": [
{
"name": "node",
"type": {
"fqn": "constructs.IConstruct"
}
}
]
}
],
"name": "EfsRecommendedAlarmsAspect",
"symbolId": "src/efs:EfsRecommendedAlarmsAspect"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.EfsRecommendedAlarmsMetrics": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "The recommended metrics for EFS alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsRecommendedAlarmsMetrics",
"kind": "enum",
"locationInModule": {
"filename": "src/efs.ts",
"line": 13
},
"members": [
{
"docs": {
"stability": "stable",
"summary": "Percentage of how close a file system is to reaching the I/O limit of the General Purpose performance mode."
},
"name": "PERCENT_IO_LIMIT"
},
{
"docs": {
"remarks": "Burst credits allow a file system to burst\nto throughput levels above a file system's baseline level for periods of time.",
"stability": "stable",
"summary": "The number of burst credits that a file system has."
},
"name": "BURST_CREDIT_BALANCE"
}
],
"name": "EfsRecommendedAlarmsMetrics",
"symbolId": "src/efs:EfsRecommendedAlarmsMetrics"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheAlarmBaseConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common optional configuration for the alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheAlarmBaseConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 36
},
"name": "ElastiCacheAlarmBaseConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "Duration.minutes(1)",
"stability": "stable",
"summary": "The period over which the specified statistic is applied."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 42
},
"name": "period",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.Duration"
}
}
],
"symbolId": "src/elasticache:ElastiCacheAlarmBaseConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common properties for the ElastiCache CfnCacheCluster alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterAlarmProps",
"kind": "interface",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 48
},
"name": "ElastiCacheClusterAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The ElastiCache CfnCacheCluster to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 52
},
"name": "cacheCluster",
"type": {
"fqn": "aws-cdk-lib.aws_elasticache.CfnCacheCluster"
}
}
],
"symbolId": "src/elasticache:ElastiCacheClusterAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "When your DatabaseMemoryUsagePercentage reaches 100%, the Redis OSS maxmemory policy is triggered and evictions might occur\nbased on the policy selected. If no object in the cache matches the eviction policy, write operations fail. Some workloads\nexpect or rely on evictions, but if not, you will need to increase the memory capacity of your cluster. You can scale your\ncluster out by adding more primary nodes, or scale it up by using a larger node type.\nRefer to {@link https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html Scaling ElastiCache for Redis OSS clusters} for details.\n\nThe alarm is triggered when the percentage exceeds % threshold.",
"stability": "stable",
"summary": "This alarm helps you monitor the memory utilization of your cluster."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 122
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterDatabaseMemoryUsagePercentageAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 121
},
"name": "ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm",
"symbolId": "src/elasticache:ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterDatabaseMemoryUsagePercentageAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterDatabaseMemoryUsagePercentageAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 106
},
"name": "ElastiCacheClusterDatabaseMemoryUsagePercentageAlarmProps",
"symbolId": "src/elasticache:ElastiCacheClusterDatabaseMemoryUsagePercentageAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterEngineCpuUtilizationAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "Common reasons for high engine CPU are long-running commands that consume high CPU, a high number of requests, an increase of new\nclient connection requests in a short time period, and high evictions when the cache doesn't have enough memory to hold new data.\nYou should consider {@link https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html Scaling ElastiCache for Redis OSS clusters}\nby adding more nodes or scaling up your instance type.\n\nThe alarm is triggered when the percentage exceeds the threshold.",
"stability": "stable",
"summary": "This alarm helps to monitor the CPU utilization of a Redis OSS engine thread within the ElastiCache instance."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterEngineCpuUtilizationAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 275
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterEngineCpuUtilizationAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 274
},
"name": "ElastiCacheClusterEngineCpuUtilizationAlarm",
"symbolId": "src/elasticache:ElastiCacheClusterEngineCpuUtilizationAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterEngineCpuUtilizationAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the ElastiCacheClusterEngineCpuUtilizationAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterEngineCpuUtilizationAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheEngineCpuUtilizationAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 260
},
"name": "ElastiCacheClusterEngineCpuUtilizationAlarmProps",
"symbolId": "src/elasticache:ElastiCacheClusterEngineCpuUtilizationAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ElastiCache",
"stability": "stable",
"summary": "A construct that creates the recommended alarms for an ElastiCache CfnCacheCluster."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 603
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 587
},
"name": "ElastiCacheClusterRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The DatabaseMemoryUsagePercentage alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 591
},
"name": "alarmDatabaseMemoryUsagePercentage",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The EngineCpuUtilization alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 596
},
"name": "alarmEngineCpuUtilization",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterEngineCpuUtilizationAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The ReplicationLag alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 601
},
"name": "alarmReplicationLag",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterReplicationLagAlarm"
}
}
],
"symbolId": "src/elasticache:ElastiCacheClusterRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterRecommendedAlarmsAspect": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ElastiCache",
"stability": "stable",
"summary": "Configures the recommended alarms for an ElastiCache CfnCacheCluster."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterRecommendedAlarmsAspect",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 942
},
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterRecommendedAlarmsConfig"
}
}
]
},
"interfaces": [
"aws-cdk-lib.IAspect"
],
"kind": "class",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 941
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "All aspects can visit an IConstruct."
},
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 944
},
"name": "visit",
"overrides": "aws-cdk-lib.IAspect",
"parameters": [
{
"name": "node",
"type": {
"fqn": "constructs.IConstruct"
}
}
]
}
],
"name": "ElastiCacheClusterRecommendedAlarmsAspect",
"symbolId": "src/elasticache:ElastiCacheClusterRecommendedAlarmsAspect"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "Default actions are overridden by the actions specified in the\nindividual alarm configurations.",
"stability": "stable",
"summary": "Configurations for the recommended alarms for an ElastiCache Service."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterRecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 521
},
"name": "ElastiCacheClusterRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the DatabaseMemoryUsagePercentage alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 561
},
"name": "configDatabaseMemoryUsagePercentageAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the ReplicationLag alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 569
},
"name": "configReplicationLagAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationLagAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the EngineCpuUtilization alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 565
},
"name": "configEngineCpuUtilizationAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheEngineCpuUtilizationAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 527
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 539
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 533
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 551
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheRecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 557
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 545
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/elasticache:ElastiCacheClusterRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the ElastiCacheClusterRecommendedAlarms construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 575
},
"name": "ElastiCacheClusterRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The ElastiCache CfnCacheCluster to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 579
},
"name": "cacheCluster",
"type": {
"fqn": "aws-cdk-lib.aws_elasticache.CfnCacheCluster"
}
}
],
"symbolId": "src/elasticache:ElastiCacheClusterRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterReplicationLagAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "A high replication lag means that the primary node or the replica can't keep up the pace of the replication. If your write\nactivity is too high, consider scaling your cluster out by adding more primary nodes, or scaling it up by using a larger node type.\nRefer to {@link https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html Scaling ElastiCache for Redis OSS clusters} for\ndetails. If your read replicas are overloaded by the amount of read requests,\nconsider adding more read replicas.\n\nThe alarm is triggered when the number of milliseconds exceeds the threshold.",
"stability": "stable",
"summary": "This alarm helps to monitor the replication health of your ElastiCache cluster."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterReplicationLagAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 422
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterReplicationLagAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 421
},
"name": "ElastiCacheClusterReplicationLagAlarm",
"symbolId": "src/elasticache:ElastiCacheClusterReplicationLagAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterReplicationLagAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the ElastiCacheClusterReplicationLagAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterReplicationLagAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheClusterAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationLagAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 406
},
"name": "ElastiCacheClusterReplicationLagAlarmProps",
"symbolId": "src/elasticache:ElastiCacheClusterReplicationLagAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the DatabaseMemoryUsagePercentage alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 68
},
"name": "ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "You can use historical memory usage data as reference for acceptable memory usage threshold.",
"stability": "stable",
"summary": "Depending on your application's memory requirements and the memory capacity of your ElastiCache cluster, you should set the threshold to the percentage that reflects the critical level of memory usage of the cluster."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 74
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect high memory utilization of your cluster so that you can avoid failures when writing to\nyour cluster. It is useful to know when you will need to scale up your cluster if your application does not expect to experience\nevictions.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 100
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- logicalId + ' - DatabaseMemoryUsagePercentage'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 92
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 86
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 80
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/elasticache:ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheEngineCpuUtilizationAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the EngineCpuUtilization alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheEngineCpuUtilizationAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 220
},
"name": "ElastiCacheEngineCpuUtilizationAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect high CPU utilization of the Redis OSS engine thread. It is useful if you want\nto monitor the CPU usage of the database engine itself.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 254
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- logicalId + ' - EngineCPUUtilization'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 247
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 241
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 235
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "90",
"remarks": "You can benchmark your cluster using your application and expected workload to correlate EngineCPUUtilization and\nperformance as a reference, and then set the threshold accordingly. In most cases, you can set the threshold to\nabout 90% of your available CPU.",
"stability": "stable",
"summary": "Set the threshold to a percentage that reflects the critical engine CPU utilization level for your application."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 229
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/elasticache:ElastiCacheEngineCpuUtilizationAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheRecommendedAlarmsMetrics": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "The recommended metrics for ElastiCache alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheRecommendedAlarmsMetrics",
"kind": "enum",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 13
},
"members": [
{
"docs": {
"stability": "stable",
"summary": "Percentage of the memory for the cluster that is in use."
},
"name": "DATABASE_MEMORY_USAGE_PERCENTAGE"
},
{
"docs": {
"remarks": "Because Valkey and Redis OSS are single-threaded,\nyou can use this metric to analyze the load of the process itself. The `EngineCPUUtilization` metric provides a more\nprecise visibility of the process. You can use it in conjunction with the `CPUUtilization` metric. `CPUUtilization`\nexposes CPU utilization for the server instance as a whole, including other operating system and management processes.\nFor larger node types with four vCPUs or more, use the EngineCPUUtilization metric to monitor and set thresholds for scaling.",
"stability": "stable",
"summary": "Provides CPU utilization of the Valkey or Redis OSS engine thread."
},
"name": "ENGINE_CPU_UTILIZATION"
},
{
"docs": {
"remarks": "For Valkey 7.2 and onwards,\nand Redis OSS engine version 5.0.6 onwards, the lag can be measured in milliseconds.",
"stability": "stable",
"summary": "It represents how far behind, in seconds, the replica is in applying changes from the primary node."
},
"name": "REPLICATION_LAG"
}
],
"name": "ElastiCacheRecommendedAlarmsMetrics",
"symbolId": "src/elasticache:ElastiCacheRecommendedAlarmsMetrics"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common properties for the ElastiCache CfnReplicationGroup alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupAlarmProps",
"kind": "interface",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 58
},
"name": "ElastiCacheReplicationGroupAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The ElastiCache CfnReplicationGroup to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 62
},
"name": "cacheReplicationGroup",
"type": {
"fqn": "aws-cdk-lib.aws_elasticache.CfnReplicationGroup"
}
}
],
"symbolId": "src/elasticache:ElastiCacheReplicationGroupAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "When your DatabaseMemoryUsagePercentage reaches 100%, the Redis OSS maxmemory policy is triggered and evictions might occur\nbased on the policy selected. If no object in the cache matches the eviction policy, write operations fail. Some workloads\nexpect or rely on evictions, but if not, you will need to increase the memory capacity of your cluster. You can scale your\ncluster out by adding more primary nodes, or scale it up by using a larger node type.\nRefer to {@link https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html Scaling ElastiCache for Redis OSS clusters} for details.\n\nThe alarm is triggered when the percentage exceeds % threshold.",
"stability": "stable",
"summary": "This alarm helps you monitor the memory utilization of your cluster."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 179
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 178
},
"name": "ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm",
"symbolId": "src/elasticache:ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 163
},
"name": "ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarmProps",
"symbolId": "src/elasticache:ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupEngineCpuUtilizationAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "Common reasons for high engine CPU are long-running commands that consume high CPU, a high number of requests, an increase of new\nclient connection requests in a short time period, and high evictions when the cache doesn't have enough memory to hold new data.\nYou should consider {@link https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html Scaling ElastiCache for Redis OSS clusters}\nby adding more nodes or scaling up your instance type.\n\nThe alarm is triggered when the percentage exceeds the threshold.",
"stability": "stable",
"summary": "This alarm helps to monitor the CPU utilization of a Redis OSS engine thread within the ElastiCache instance."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupEngineCpuUtilizationAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 330
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupEngineCpuUtilizationAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 329
},
"name": "ElastiCacheReplicationGroupEngineCpuUtilizationAlarm",
"symbolId": "src/elasticache:ElastiCacheReplicationGroupEngineCpuUtilizationAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupEngineCpuUtilizationAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the ElastiCacheReplicationGroupEngineCpuUtilizationAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupEngineCpuUtilizationAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheEngineCpuUtilizationAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 315
},
"name": "ElastiCacheReplicationGroupEngineCpuUtilizationAlarmProps",
"symbolId": "src/elasticache:ElastiCacheReplicationGroupEngineCpuUtilizationAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ElastiCache",
"stability": "stable",
"summary": "A construct that creates the recommended alarms for an ElastiCache CfnReplicationGroup."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 759
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 743
},
"name": "ElastiCacheReplicationGroupRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The DatabaseMemoryUsagePercentage alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 747
},
"name": "alarmDatabaseMemoryUsagePercentage",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The EngineCpuUtilization alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 752
},
"name": "alarmEngineCpuUtilization",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupEngineCpuUtilizationAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The ReplicationLag alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 757
},
"name": "alarmReplicationLag",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupReplicationLagAlarm"
}
}
],
"symbolId": "src/elasticache:ElastiCacheReplicationGroupRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupRecommendedAlarmsAspect": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ElastiCache",
"stability": "stable",
"summary": "Configures the recommended alarms for an ElastiCache CfnReplicationGroup."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupRecommendedAlarmsAspect",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 966
},
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupRecommendedAlarmsConfig"
}
}
]
},
"interfaces": [
"aws-cdk-lib.IAspect"
],
"kind": "class",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 965
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "All aspects can visit an IConstruct."
},
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 968
},
"name": "visit",
"overrides": "aws-cdk-lib.IAspect",
"parameters": [
{
"name": "node",
"type": {
"fqn": "constructs.IConstruct"
}
}
]
}
],
"name": "ElastiCacheReplicationGroupRecommendedAlarmsAspect",
"symbolId": "src/elasticache:ElastiCacheReplicationGroupRecommendedAlarmsAspect"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "Default actions are overridden by the actions specified in the\nindividual alarm configurations.",
"stability": "stable",
"summary": "Configurations for the recommended alarms for an ElastiCache ReplicationGroup."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupRecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 677
},
"name": "ElastiCacheReplicationGroupRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the DatabaseMemoryUsagePercentage alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 717
},
"name": "configDatabaseMemoryUsagePercentageAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the ReplicationLag alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 725
},
"name": "configReplicationLagAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationLagAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the EngineCPUUtilization alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 721
},
"name": "configEngineCpuUtilizationAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheEngineCpuUtilizationAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 683
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 695
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 689
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 707
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheRecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 713
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 701
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/elasticache:ElastiCacheReplicationGroupRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the ElastiCacheReplicationGroupRecommendedAlarms construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 731
},
"name": "ElastiCacheReplicationGroupRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The ElastiCache CfnReplicationGroup to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 735
},
"name": "cacheReplicationGroup",
"type": {
"fqn": "aws-cdk-lib.aws_elasticache.CfnReplicationGroup"
}
}
],
"symbolId": "src/elasticache:ElastiCacheReplicationGroupRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupReplicationLagAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "A high replication lag means that the primary node or the replica can't keep up the pace of the replication. If your write\nactivity is too high, consider scaling your cluster out by adding more primary nodes, or scaling it up by using a larger node type.\nRefer to {@link https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html Scaling ElastiCache for Redis OSS clusters} for\ndetails. If your read replicas are overloaded by the amount of read requests,\nconsider adding more read replicas.\n\nThe alarm is triggered when the number of milliseconds exceeds the threshold.",
"stability": "stable",
"summary": "This alarm helps to monitor the replication health of your ElastiCache cluster."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupReplicationLagAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 478
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupReplicationLagAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 477
},
"name": "ElastiCacheReplicationGroupReplicationLagAlarm",
"symbolId": "src/elasticache:ElastiCacheReplicationGroupReplicationLagAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupReplicationLagAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the ElastiCacheReplicationGroupReplicationLagAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupReplicationLagAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationGroupAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationLagAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 462
},
"name": "ElastiCacheReplicationGroupReplicationLagAlarmProps",
"symbolId": "src/elasticache:ElastiCacheReplicationGroupReplicationLagAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationLagAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the ReplicationLag alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheReplicationLagAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.ElastiCacheAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 370
},
"name": "ElastiCacheReplicationLagAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "You should\nconsider your application's expected write rates and network conditions for the acceptable replication lag.",
"stability": "stable",
"summary": "Set the threshold according to your application's requirements and the potential impact of replication lag."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 375
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect a delay between data updates on the primary node and their synchronization to replica node.\nIt helps to ensure data consistency of a read replica cluster node.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 400
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- logicalId + ' - ReplicationLag'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 393
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "15",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 387
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "15",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/elasticache.ts",
"line": 381
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/elasticache:ElastiCacheReplicationLagAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.FargateService": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_ecs.FargateService",
"docs": {
"stability": "stable",
"summary": "An extension for the FargateService construct that provides methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.FargateService",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/ecs.ts",
"line": 602
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "aws-cdk-lib.aws_ecs.FargateServiceProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/ecs.ts",
"line": 601
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the CPU utilization for the Fargate service."
},
"locationInModule": {
"filename": "src/ecs.ts",
"line": 609
},
"name": "alarmCpuUtilization",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsCpuUtilizationAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceCpuUtilizationAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the ephemeral storage utilized for the Fargate service."
},
"locationInModule": {
"filename": "src/ecs.ts",
"line": 629
},
"name": "alarmEphemeralStorageUtilized",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsEphemeralStorageUtilizedAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceEphemeralStorageUtilizedAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the memory utilization for the Fargate service."
},
"locationInModule": {
"filename": "src/ecs.ts",
"line": 619
},
"name": "alarmMemoryUtilization",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsMemoryUtilizationAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceMemoryUtilizationAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the number of task running."
},
"locationInModule": {
"filename": "src/ecs.ts",
"line": 639
},
"name": "alarmRunningTaskCount",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsRunningTaskCountAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceRunningTaskCountAlarm"
}
}
},
{
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ECS",
"stability": "stable",
"summary": "Creates the recommended alarms for the ECS service."
},
"locationInModule": {
"filename": "src/ecs.ts",
"line": 651
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceRecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EcsServiceRecommendedAlarms"
}
}
}
],
"name": "FargateService",
"symbolId": "src/ecs:FargateService"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.FileSystem": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_efs.FileSystem",
"docs": {
"stability": "stable",
"summary": "An extension for the FileSystem construct that provides methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.FileSystem",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/efs.ts",
"line": 365
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "aws-cdk-lib.aws_efs.FileSystemProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/efs.ts",
"line": 364
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the BurstCreditBalance for the EFS fileSystem."
},
"locationInModule": {
"filename": "src/efs.ts",
"line": 382
},
"name": "alarmBurstCreditBalance",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsBurstCreditBalanceAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemBurstCreditBalanceAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the PercentIOLimit for the EFS fileSystem."
},
"locationInModule": {
"filename": "src/efs.ts",
"line": 372
},
"name": "alarmPercentIOLimit",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsPercentIOLimitAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemPercentIOLimitAlarm"
}
}
},
{
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#EFS",
"stability": "stable",
"summary": "Creates the recommended alarms for the EFS FileSystem."
},
"locationInModule": {
"filename": "src/efs.ts",
"line": 394
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemRecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.EfsFileSystemRecommendedAlarms"
}
}
}
],
"name": "FileSystem",
"symbolId": "src/efs:FileSystem"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.Function": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_lambda.Function",
"docs": {
"stability": "stable",
"summary": "An extension of the Lambda function construct that provides methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Function",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/lambda.ts",
"line": 598
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "aws-cdk-lib.aws_lambda.FunctionProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/lambda.ts",
"line": 597
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the number of concurrent executions."
},
"locationInModule": {
"filename": "src/lambda.ts",
"line": 635
},
"name": "alarmConcurrentExecutions",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaConcurrentExecutionsAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaConcurrentExecutionsAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the duration of the function invocations."
},
"locationInModule": {
"filename": "src/lambda.ts",
"line": 625
},
"name": "alarmDuration",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaDurationAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaDurationAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the number of errors."
},
"locationInModule": {
"filename": "src/lambda.ts",
"line": 605
},
"name": "alarmErrors",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaErrorsAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaErrorsAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the number of throttles."
},
"locationInModule": {
"filename": "src/lambda.ts",
"line": 615
},
"name": "alarmThrottles",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaThrottlesAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaThrottlesAlarm"
}
}
},
{
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#Lambda",
"stability": "stable",
"summary": "Creates recommended alarms for the Lambda function."
},
"locationInModule": {
"filename": "src/lambda.ts",
"line": 647
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaRecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaRecommendedAlarms"
}
}
}
],
"name": "Function",
"symbolId": "src/lambda:Function"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.Instance": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_ec2.Instance",
"docs": {
"stability": "stable",
"summary": "An extension for the Instance construct that provides methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Instance",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/ec2.ts",
"line": 361
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "aws-cdk-lib.aws_ec2.InstanceProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/ec2.ts",
"line": 360
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the CPUUtilization for the EC2 instance."
},
"locationInModule": {
"filename": "src/ec2.ts",
"line": 368
},
"name": "alarmCpuUtilization",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2CpuUtilizationAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceCpuUtilizationAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the StatusCheckFailed for the EC2 instance."
},
"locationInModule": {
"filename": "src/ec2.ts",
"line": 378
},
"name": "alarmStatusCheckFailed",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2StatusCheckFailedAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceStatusCheckFailedAlarm"
}
}
},
{
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#EC2",
"stability": "stable",
"summary": "Creates the recommended alarms for the EC2 Instance."
},
"locationInModule": {
"filename": "src/ec2.ts",
"line": 390
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceRecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Ec2InstanceRecommendedAlarms"
}
}
}
],
"name": "Instance",
"symbolId": "src/ec2:Instance"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.InterfaceVpcEndpoint": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_ec2.InterfaceVpcEndpoint",
"docs": {
"stability": "stable",
"summary": "An extension for the InterfaceVpcEndpoint construct that provides methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.InterfaceVpcEndpoint",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 299
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "aws-cdk-lib.aws_ec2.InterfaceVpcEndpointProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 298
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the PacketsDropped for the PrivateLink endpoint."
},
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 306
},
"name": "alarmPacketsDropped",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsPacketsDroppedAlarmConfig"
}
}
],
"returns": {
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm"
},
"kind": "array"
}
}
}
},
{
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#PrivateLinkEndpoints",
"stability": "stable",
"summary": "Creates the recommended alarms for the PrivateLink InterfaceVpcEndpoint."
},
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 341
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarms"
}
}
}
],
"name": "InterfaceVpcEndpoint",
"symbolId": "src/privatelink:InterfaceVpcEndpoint"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaAlarmBaseConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable"
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaAlarmBaseConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/lambda.ts",
"line": 32
},
"name": "LambdaAlarmBaseConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "Duration.minutes(1)",
"stability": "stable",
"summary": "The period over which the specified statistic is applied."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 38
},
"name": "period",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.Duration"
}
}
],
"symbolId": "src/lambda:LambdaAlarmBaseConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaConcurrentExecutionsAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "A function is\nthrottled if it reaches the Region-level concurrency quota\nof the account.\n\nThe alarm is triggered when the number of concurrent executions\nexceeds the specified threshold.",
"stability": "stable",
"summary": "This alarm can proactively detect if the concurrency of the function is approaching the Region-level concurrency quota of your account, so that you can act on it."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaConcurrentExecutionsAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/lambda.ts",
"line": 383
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaConcurrentExecutionsAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/lambda.ts",
"line": 382
},
"name": "LambdaConcurrentExecutionsAlarm",
"symbolId": "src/lambda:LambdaConcurrentExecutionsAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaConcurrentExecutionsAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the ConcurrentExecutions alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaConcurrentExecutionsAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/lambda.ts",
"line": 322
},
"name": "LambdaConcurrentExecutionsAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm helps to monitor if the concurrency of the function is approaching the Region-level\nconcurrency limit of your account. A function starts to be throttled if it reaches the concurrency limit.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 359
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- lambdaFunction.functionName + ' - ConcurrentExecutions'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 352
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "10",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 346
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "10",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 340
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "900",
"remarks": "Set the threshold to about 90% of the concurrency quota set\nfor the account in the Region. By default, your account has\na concurrency quota of 1,000 across all functions in a Region.\nHowever, you can check the quota of your account, as it can\nbe increased by contacting AWS support.",
"stability": "stable",
"summary": "The value against which the specified statictis is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 334
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/lambda:LambdaConcurrentExecutionsAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaConcurrentExecutionsAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the LambdaConcurrentExecutionsAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaConcurrentExecutionsAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaConcurrentExecutionsAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/lambda.ts",
"line": 365
},
"name": "LambdaConcurrentExecutionsAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The Lambda function to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 369
},
"name": "lambdaFunction",
"type": {
"fqn": "aws-cdk-lib.aws_lambda.IFunction"
}
}
],
"symbolId": "src/lambda:LambdaConcurrentExecutionsAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaDurationAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "High runtime duration indicates that\na function is taking a longer time for invocation, and\ncan also impact the concurrency capacity of invocation\nif Lambda is handling a higher number of events. It is\ncritical to know if the Lambda function is constantly\ntaking longer execution time than expected.\n\nThe alarm is triggered when the duration of the function\ninvocations exceeds the specified threshold.",
"stability": "stable",
"summary": "This alarm can detect a long running duration of a Lambda function."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaDurationAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/lambda.ts",
"line": 291
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaDurationAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/lambda.ts",
"line": 290
},
"name": "LambdaDurationAlarm",
"symbolId": "src/lambda:LambdaDurationAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaDurationAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the Duration alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaDurationAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/lambda.ts",
"line": 226
},
"name": "LambdaDurationAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "The threshold for the duration depends on your application\nand workloads and your performance requirements. For\nhigh-performance requirements, set the threshold to a\nshorter time to see if the function is meeting expectations.\nYou can also analyze historical data for duration metrics\nto see the if the time taken matches the performance\nexpectation of the function, and then set the threshold to\na longer time than the historical average. Make sure to\nset the threshold lower than the configured function\ntimeout.",
"stability": "stable",
"summary": "The value against which the specified statictis is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 241
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm detects long duration times for processing an event by a Lambda function. Long durations might be because of changes in function code making the function take longer to execute, or the function's dependencies taking longer.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 265
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- lambdaFunction.functionName + ' - Duration'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 259
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "15",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 253
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "15",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 247
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/lambda:LambdaDurationAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaDurationAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the LambdaDurationAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaDurationAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaDurationAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/lambda.ts",
"line": 271
},
"name": "LambdaDurationAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The Lambda function to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 275
},
"name": "lambdaFunction",
"type": {
"fqn": "aws-cdk-lib.aws_lambda.IFunction"
}
}
],
"symbolId": "src/lambda:LambdaDurationAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaErrorsAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "The alarm is triggered when the number of errors exceeds the specified\nthreshold.",
"stability": "stable",
"summary": "The alarm helps detect high error counts in function invocations."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaErrorsAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/lambda.ts",
"line": 101
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaErrorsAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/lambda.ts",
"line": 100
},
"name": "LambdaErrorsAlarm",
"symbolId": "src/lambda:LambdaErrorsAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaErrorsAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the Errors alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaErrorsAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/lambda.ts",
"line": 44
},
"name": "LambdaErrorsAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "Set the threshold to a number greater than zero. The exact\nvalue can depend on the tolerance for errors in your\napplication. Understand the criticality of the invocations\nthat the function is handling. For some applications, any\nerror might be unacceptable, while other applications might\nallow for a certain margin of error.",
"stability": "stable",
"summary": "The value against which the specified statistics is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 55
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm detects high error counts. Errors includes the exceptions thrown by the code\nas well as exceptions thrown by the Lambda runtime. You can check the logs related to the function\nto diagnose the issue.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 81
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- lambdaFunction.functionName + ' - Errors'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 73
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "3",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 67
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "3",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 61
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/lambda:LambdaErrorsAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaErrorsAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the LambdaErrorsAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaErrorsAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaErrorsAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/lambda.ts",
"line": 87
},
"name": "LambdaErrorsAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The Lambda function to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 91
},
"name": "lambdaFunction",
"type": {
"fqn": "aws-cdk-lib.aws_lambda.IFunction"
}
}
],
"symbolId": "src/lambda:LambdaErrorsAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#Lambda",
"stability": "stable",
"summary": "A construct that creates recommended alarms for a Lambda function."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/lambda.ts",
"line": 508
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/lambda.ts",
"line": 490
},
"name": "LambdaRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The concurrent executions alarm for the Lambda function."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 506
},
"name": "alarmConcurrentExecutions",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaConcurrentExecutionsAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The duration alarm for the Lambda function."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 502
},
"name": "alarmDuration",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaDurationAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The error alarm for the Lambda function."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 494
},
"name": "alarmErrors",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaErrorsAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The throttles alarm for the Lambda function."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 498
},
"name": "alarmThrottles",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaThrottlesAlarm"
}
}
],
"symbolId": "src/lambda:LambdaRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaRecommendedAlarmsAspect": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#Lambda",
"stability": "stable",
"summary": "An aspect that applies recommended alarms for Lambda functions."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaRecommendedAlarmsAspect",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/lambda.ts",
"line": 661
},
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaRecommendedAlarmsConfig"
}
}
]
},
"interfaces": [
"aws-cdk-lib.IAspect"
],
"kind": "class",
"locationInModule": {
"filename": "src/lambda.ts",
"line": 660
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "All aspects can visit an IConstruct."
},
"locationInModule": {
"filename": "src/lambda.ts",
"line": 663
},
"name": "visit",
"overrides": "aws-cdk-lib.IAspect",
"parameters": [
{
"name": "node",
"type": {
"fqn": "constructs.IConstruct"
}
}
]
}
],
"name": "LambdaRecommendedAlarmsAspect",
"symbolId": "src/lambda:LambdaRecommendedAlarmsAspect"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "Default actions are overridden by the actions specified in the\nindividual alarm configurations.",
"stability": "stable",
"summary": "Configuration for Lambda recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaRecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/lambda.ts",
"line": 423
},
"name": "LambdaRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the Duration alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 471
},
"name": "configDurationAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaDurationAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the Errors alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 463
},
"name": "configErrorsAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaErrorsAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the Throttles alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 467
},
"name": "configThrottlesAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaThrottlesAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the ConcurrentExecutions alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 475
},
"name": "configConcurrentExecutionsAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaConcurrentExecutionsAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 429
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 441
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 435
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 453
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaRecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 459
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 447
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/lambda:LambdaRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaRecommendedAlarmsMetrics": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "The recommended metrics for Lambda alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaRecommendedAlarmsMetrics",
"kind": "enum",
"locationInModule": {
"filename": "src/lambda.ts",
"line": 13
},
"members": [
{
"docs": {
"stability": "stable",
"summary": "Errors include the exceptions thrown by the code as well as exceptions thrown by the Lambda runtime."
},
"name": "ERRORS"
},
{
"docs": {
"stability": "stable",
"summary": "Throttles occur when there is no concurrency available for scale up."
},
"name": "THROTTLES"
},
{
"docs": {
"stability": "stable",
"summary": "Duration is the time taken for the function to process an event."
},
"name": "DURATION"
},
{
"docs": {
"stability": "stable",
"summary": "ConcurrentExecutions is the number of concurrent executions of the function."
},
"name": "CONCURRENT_EXECUTIONS"
}
],
"name": "LambdaRecommendedAlarmsMetrics",
"symbolId": "src/lambda:LambdaRecommendedAlarmsMetrics"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable"
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/lambda.ts",
"line": 478
},
"name": "LambdaRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The lambda function to apply the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 482
},
"name": "lambdaFunction",
"type": {
"fqn": "aws-cdk-lib.aws_lambda.IFunction"
}
}
],
"symbolId": "src/lambda:LambdaRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaThrottlesAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "It is important to know if requests are constantly\ngetting rejected due to throttling and if you need to improve Lambda\nfunction performance or increase concurrency capacity to avoid constant\nthrottling.\n\nThe alarm is triggered when the number of throttles exceeds or equals\nthe specified threshold.",
"stability": "stable",
"summary": "The alarm helps detect a high number of throttled invocation requests for a Lambda function."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaThrottlesAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/lambda.ts",
"line": 193
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaThrottlesAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/lambda.ts",
"line": 192
},
"name": "LambdaThrottlesAlarm",
"symbolId": "src/lambda:LambdaThrottlesAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaThrottlesAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the Throttles alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaThrottlesAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/lambda.ts",
"line": 132
},
"name": "LambdaThrottlesAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "Set the threshold to a number greater than zero. The exact value\nof the threshold can depend on the tolerance of the application.\nSet the threshold according to its usage and scaling requirements\nof the function.",
"stability": "stable",
"summary": "The value against which the specified statictis is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 141
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm detects a high number of throttled invocation requests. Throttling occurs when\nthere is no concurrency is available for scale up. There are several approaches to resolve this issue.\n1) Request a concurrency increase from AWS Support in this Region. 2) Identify performance issues in\nthe function to improve the speed of processing and therefore improve throughput. 3) Increase the batch\nsize of the function, so that more messages are processed by each function invocation.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 169
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- lambdaFunction.functionName + ' - Throttles'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 159
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 153
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 147
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/lambda:LambdaThrottlesAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaThrottlesAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the LambdaThrottlesAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.LambdaThrottlesAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.LambdaThrottlesAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/lambda.ts",
"line": 175
},
"name": "LambdaThrottlesAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The Lambda function to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/lambda.ts",
"line": 179
},
"name": "lambdaFunction",
"type": {
"fqn": "aws-cdk-lib.aws_lambda.IFunction"
}
}
],
"symbolId": "src/lambda:LambdaThrottlesAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancer": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_elasticloadbalancingv2.NetworkLoadBalancer",
"docs": {
"stability": "stable",
"summary": "An extension for the NetworkLoadBalancer construct that provides methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancer",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 353
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.NetworkLoadBalancerProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 352
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the TCP reset count from the load balancer."
},
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 360
},
"name": "alarmTcpElbResetCount",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpElbResetCountAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpElbResetCountAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the TCP reset count from targets."
},
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 370
},
"name": "alarmTcpTargetResetCount",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpTargetResetCountAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpTargetResetCountAlarm"
}
}
},
{
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html",
"stability": "stable",
"summary": "Creates the recommended alarms for the NetworkLoadBalancer."
},
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 382
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerRecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerRecommendedAlarms"
}
}
}
],
"name": "NetworkLoadBalancer",
"symbolId": "src/networkloadbalancer:NetworkLoadBalancer"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerAlarmBaseConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common optional configuration for the alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerAlarmBaseConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 27
},
"name": "NetworkLoadBalancerAlarmBaseConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "Duration.minutes(1)",
"stability": "stable",
"summary": "The period over which the specified statistic is applied."
},
"immutable": true,
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 33
},
"name": "period",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.Duration"
}
}
],
"symbolId": "src/networkloadbalancer:NetworkLoadBalancerAlarmBaseConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common properties for the NetworkLoadBalancer alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerAlarmProps",
"kind": "interface",
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 39
},
"name": "NetworkLoadBalancerAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The NetworkLoadBalancer to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 43
},
"name": "loadBalancer",
"type": {
"fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.NetworkLoadBalancer"
}
}
],
"symbolId": "src/networkloadbalancer:NetworkLoadBalancerAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html",
"stability": "stable",
"summary": "A construct that creates the recommended alarms for a NetworkLoadBalancer."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 303
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 292
},
"name": "NetworkLoadBalancerRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The TcpElbResetCount alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 296
},
"name": "alarmTcpElbResetCount",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpElbResetCountAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The TcpTargetResetCount alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 301
},
"name": "alarmTcpTargetResetCount",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpTargetResetCountAlarm"
}
}
],
"symbolId": "src/networkloadbalancer:NetworkLoadBalancerRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerRecommendedAlarmsAspect": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html",
"stability": "stable",
"summary": "Configures the recommended alarms for a NetworkLoadBalancer."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerRecommendedAlarmsAspect",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 396
},
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerRecommendedAlarmsConfig"
}
}
]
},
"interfaces": [
"aws-cdk-lib.IAspect"
],
"kind": "class",
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 395
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "All aspects can visit an IConstruct."
},
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 398
},
"name": "visit",
"overrides": "aws-cdk-lib.IAspect",
"parameters": [
{
"name": "node",
"type": {
"fqn": "constructs.IConstruct"
}
}
]
}
],
"name": "NetworkLoadBalancerRecommendedAlarmsAspect",
"symbolId": "src/networkloadbalancer:NetworkLoadBalancerRecommendedAlarmsAspect"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "Default actions are overridden by the actions specified in the\nindividual alarm configurations.",
"stability": "stable",
"summary": "Configurations for the recommended alarms for a NetworkLoadBalancer."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerRecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 230
},
"name": "NetworkLoadBalancerRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the TcpElbResetCount alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 270
},
"name": "configTcpElbResetCountAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpElbResetCountAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the TcpTargetResetCount alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 274
},
"name": "configTcpTargetResetCountAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpTargetResetCountAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 236
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 248
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 242
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 260
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerRecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 266
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 254
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/networkloadbalancer:NetworkLoadBalancerRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerRecommendedAlarmsMetrics": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "The recommended metrics for NetworkLoadBalancer alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerRecommendedAlarmsMetrics",
"kind": "enum",
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 13
},
"members": [
{
"docs": {
"stability": "stable",
"summary": "The number of reset (RST) packets sent from the load balancer."
},
"name": "TCP_ELB_RESET_COUNT"
},
{
"docs": {
"stability": "stable",
"summary": "The number of reset (RST) packets generated by the targets."
},
"name": "TCP_TARGET_RESET_COUNT"
}
],
"name": "NetworkLoadBalancerRecommendedAlarmsMetrics",
"symbolId": "src/networkloadbalancer:NetworkLoadBalancerRecommendedAlarmsMetrics"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the NetworkLoadBalancerRecommendedAlarms construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 280
},
"name": "NetworkLoadBalancerRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The NetworkLoadBalancer to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 284
},
"name": "loadBalancer",
"type": {
"fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.NetworkLoadBalancer"
}
}
],
"symbolId": "src/networkloadbalancer:NetworkLoadBalancerRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpElbResetCountAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "A high number of resets can indicate connectivity issues between the load balancer and clients.\n\nThe alarm is triggered when the number of TCP resets from the load balancer is greater than threshold.",
"stability": "stable",
"summary": "This alarm is used to detect when the load balancer is sending TCP reset packets."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpElbResetCountAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 98
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpElbResetCountAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 97
},
"name": "NetworkLoadBalancerTcpElbResetCountAlarm",
"symbolId": "src/networkloadbalancer:NetworkLoadBalancerTcpElbResetCountAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpElbResetCountAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the TcpElbResetCount alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpElbResetCountAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 49
},
"name": "NetworkLoadBalancerTcpElbResetCountAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect when the load balancer is sending TCP reset packets.\nA high number of resets can indicate connectivity issues between the load balancer and clients.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 81
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- loadBalancerName + ' - TcpElbResetCount'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 74
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "3",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 68
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "3",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 62
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "0",
"remarks": "You should set this threshold based on the acceptable number of TCP resets from the load balancer.",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 56
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/networkloadbalancer:NetworkLoadBalancerTcpElbResetCountAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpElbResetCountAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the NetworkLoadBalancerTcpElbResetCountAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpElbResetCountAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpElbResetCountAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 87
},
"name": "NetworkLoadBalancerTcpElbResetCountAlarmProps",
"symbolId": "src/networkloadbalancer:NetworkLoadBalancerTcpElbResetCountAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpTargetResetCountAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "A high number of resets can indicate connectivity issues between the load balancer and targets.\n\nThe alarm is triggered when the number of TCP resets from targets is greater than threshold.",
"stability": "stable",
"summary": "This alarm is used to detect when the targets are sending TCP reset packets."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpTargetResetCountAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 187
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpTargetResetCountAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 186
},
"name": "NetworkLoadBalancerTcpTargetResetCountAlarm",
"symbolId": "src/networkloadbalancer:NetworkLoadBalancerTcpTargetResetCountAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpTargetResetCountAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the TcpTargetResetCount alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpTargetResetCountAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 138
},
"name": "NetworkLoadBalancerTcpTargetResetCountAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect when the targets are sending TCP reset packets.\nA high number of resets can indicate connectivity issues between the load balancer and targets.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 170
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- loadBalancerName + ' - TcpTargetResetCount'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 163
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "3",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 157
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "3",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 151
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "0",
"remarks": "You should set this threshold based on the acceptable number of TCP resets from targets.",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 145
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/networkloadbalancer:NetworkLoadBalancerTcpTargetResetCountAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpTargetResetCountAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the NetworkLoadBalancerTcpTargetResetCountAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpTargetResetCountAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkLoadBalancerTcpTargetResetCountAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/networkloadbalancer.ts",
"line": 176
},
"name": "NetworkLoadBalancerTcpTargetResetCountAlarmProps",
"symbolId": "src/networkloadbalancer:NetworkLoadBalancerTcpTargetResetCountAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroup": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_elasticloadbalancingv2.NetworkTargetGroup",
"docs": {
"stability": "stable",
"summary": "An extension for the NetworkTargetGroup construct that provides methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroup",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 350
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.NetworkTargetGroupProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 349
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the healthy host count for the NetworkTargetGroup."
},
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 357
},
"name": "alarmHealthyHostCount",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupHealthyHostCountAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupHealthyHostCountAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the unhealthy host count for the NetworkTargetGroup."
},
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 367
},
"name": "alarmUnHealthyHostCount",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupUnHealthyHostCountAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupUnHealthyHostCountAlarm"
}
}
},
{
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html",
"stability": "stable",
"summary": "Creates the recommended alarms for the NetworkTargetGroup."
},
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 379
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupRecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupRecommendedAlarms"
}
}
}
],
"name": "NetworkTargetGroup",
"symbolId": "src/networktargetgroup:NetworkTargetGroup"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupAlarmBaseConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common optional configuration for the alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupAlarmBaseConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 27
},
"name": "NetworkTargetGroupAlarmBaseConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "Duration.minutes(1)",
"stability": "stable",
"summary": "The period over which the specified statistic is applied."
},
"immutable": true,
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 33
},
"name": "period",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.Duration"
}
}
],
"symbolId": "src/networktargetgroup:NetworkTargetGroupAlarmBaseConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common properties for the NetworkTargetGroup alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupAlarmProps",
"kind": "interface",
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 39
},
"name": "NetworkTargetGroupAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The NetworkTargetGroup to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 43
},
"name": "targetGroup",
"type": {
"fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.NetworkTargetGroup"
}
}
],
"symbolId": "src/networktargetgroup:NetworkTargetGroupAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupHealthyHostCountAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "A low number of healthy hosts can indicate service availability issues.",
"stability": "stable",
"summary": "This alarm is used to detect when the number of healthy hosts in the target group falls below the threshold."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupHealthyHostCountAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 96
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupHealthyHostCountAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 95
},
"name": "NetworkTargetGroupHealthyHostCountAlarm",
"symbolId": "src/networktargetgroup:NetworkTargetGroupHealthyHostCountAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupHealthyHostCountAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the HealthyHostCount alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupHealthyHostCountAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 49
},
"name": "NetworkTargetGroupHealthyHostCountAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect when the number of healthy hosts in the target group\nfalls below the threshold. A low number of healthy hosts can indicate service availability issues.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 82
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- targetGroupName + ' - HealthyHostCount'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 75
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 69
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 63
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "1",
"remarks": "You should set this threshold based on the minimum number of healthy hosts\nrequired for your application to function properly.",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 57
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/networktargetgroup:NetworkTargetGroupHealthyHostCountAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupHealthyHostCountAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the NetworkTargetGroupHealthyHostCountAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupHealthyHostCountAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupHealthyHostCountAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 88
},
"name": "NetworkTargetGroupHealthyHostCountAlarmProps",
"symbolId": "src/networktargetgroup:NetworkTargetGroupHealthyHostCountAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html",
"stability": "stable",
"summary": "A construct that creates the recommended alarms for a NetworkTargetGroup."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 300
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 289
},
"name": "NetworkTargetGroupRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The HealthyHostCount alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 293
},
"name": "alarmHealthyHostCount",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupHealthyHostCountAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The UnHealthyHostCount alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 298
},
"name": "alarmUnHealthyHostCount",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupUnHealthyHostCountAlarm"
}
}
],
"symbolId": "src/networktargetgroup:NetworkTargetGroupRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupRecommendedAlarmsAspect": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html",
"stability": "stable",
"summary": "Configures the recommended alarms for a NetworkTargetGroup."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupRecommendedAlarmsAspect",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 393
},
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupRecommendedAlarmsConfig"
}
}
]
},
"interfaces": [
"aws-cdk-lib.IAspect"
],
"kind": "class",
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 392
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "All aspects can visit an IConstruct."
},
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 395
},
"name": "visit",
"overrides": "aws-cdk-lib.IAspect",
"parameters": [
{
"name": "node",
"type": {
"fqn": "constructs.IConstruct"
}
}
]
}
],
"name": "NetworkTargetGroupRecommendedAlarmsAspect",
"symbolId": "src/networktargetgroup:NetworkTargetGroupRecommendedAlarmsAspect"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "Default actions are overridden by the actions specified in the\nindividual alarm configurations.",
"stability": "stable",
"summary": "Configurations for the recommended alarms for a NetworkTargetGroup."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupRecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 227
},
"name": "NetworkTargetGroupRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the HealthyHostCount alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 267
},
"name": "configHealthyHostCountAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupHealthyHostCountAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the UnHealthyHostCount alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 271
},
"name": "configUnHealthyHostCountAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupUnHealthyHostCountAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 233
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 245
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 239
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 257
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupRecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 263
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 251
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/networktargetgroup:NetworkTargetGroupRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupRecommendedAlarmsMetrics": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "The recommended metrics for NetworkTargetGroup alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupRecommendedAlarmsMetrics",
"kind": "enum",
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 13
},
"members": [
{
"docs": {
"stability": "stable",
"summary": "The number of healthy targets in the target group."
},
"name": "HEALTHY_HOST_COUNT"
},
{
"docs": {
"stability": "stable",
"summary": "The number of unhealthy targets in the target group."
},
"name": "UNHEALTHY_HOST_COUNT"
}
],
"name": "NetworkTargetGroupRecommendedAlarmsMetrics",
"symbolId": "src/networktargetgroup:NetworkTargetGroupRecommendedAlarmsMetrics"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the NetworkTargetGroupRecommendedAlarms construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 277
},
"name": "NetworkTargetGroupRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The NetworkTargetGroup to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 281
},
"name": "targetGroup",
"type": {
"fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.NetworkTargetGroup"
}
}
],
"symbolId": "src/networktargetgroup:NetworkTargetGroupRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupUnHealthyHostCountAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "A high number of unhealthy hosts can indicate service health issues.",
"stability": "stable",
"summary": "This alarm is used to detect when the number of unhealthy hosts in the target group exceeds the threshold."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupUnHealthyHostCountAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 184
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupUnHealthyHostCountAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 183
},
"name": "NetworkTargetGroupUnHealthyHostCountAlarm",
"symbolId": "src/networktargetgroup:NetworkTargetGroupUnHealthyHostCountAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupUnHealthyHostCountAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the UnHealthyHostCount alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupUnHealthyHostCountAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 136
},
"name": "NetworkTargetGroupUnHealthyHostCountAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect when the number of unhealthy hosts in the target group\nexceeds the threshold. A high number of unhealthy hosts can indicate service health issues.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 169
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- targetGroupName + ' - UnHealthyHostCount'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 162
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 156
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 150
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "0",
"remarks": "You should set this threshold based on the maximum number of unhealthy hosts\nthat your application can tolerate before service is impacted.",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 144
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/networktargetgroup:NetworkTargetGroupUnHealthyHostCountAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupUnHealthyHostCountAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the NetworkTargetGroupUnHealthyHostCountAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupUnHealthyHostCountAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.NetworkTargetGroupUnHealthyHostCountAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/networktargetgroup.ts",
"line": 175
},
"name": "NetworkTargetGroupUnHealthyHostCountAlarmProps",
"symbolId": "src/networktargetgroup:NetworkTargetGroupUnHealthyHostCountAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsAlarmBaseConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common optional configuration for the alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsAlarmBaseConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 23
},
"name": "PrivateLinkEndpointsAlarmBaseConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "Duration.minutes(1)",
"stability": "stable",
"summary": "The period over which the specified statistic is applied."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 29
},
"name": "period",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.Duration"
}
}
],
"symbolId": "src/privatelink:PrivateLinkEndpointsAlarmBaseConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsInterfaceVpcEndpointAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common properties for the PrivateLink InterfaceVpcEndpoint alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsInterfaceVpcEndpointAlarmProps",
"kind": "interface",
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 35
},
"name": "PrivateLinkEndpointsInterfaceVpcEndpointAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The PrivateLink InterfaceVpcEndpoint to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 39
},
"name": "endpoint",
"type": {
"fqn": "aws-cdk-lib.aws_ec2.InterfaceVpcEndpoint"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The type of the PrivateLink InterfaceVpcEndpoint."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 47
},
"name": "endpointType",
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The service name of the PrivateLink InterfaceVpcEndpoint."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 51
},
"name": "serviceName",
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The subnet ID of the PrivateLink InterfaceVpcEndpoint."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 55
},
"name": "subnetId",
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The VPC ID of the PrivateLink InterfaceVpcEndpoint."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 43
},
"name": "vpcId",
"type": {
"primitive": "string"
}
}
],
"symbolId": "src/privatelink:PrivateLinkEndpointsInterfaceVpcEndpointAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "Note that packets larger than 8500 bytes that arrive at the VPC endpoint are dropped. For troubleshooting,\nsee connectivity problems between an interface VPC endpoint and an endpoint service.\n\nThe alarm is triggered when the number of packets dropped exceeds the threshold.",
"stability": "stable",
"summary": "This alarm helps to detect if the endpoint or endpoint service is unhealthy by monitoring the number of packets dropped by the endpoint."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 126
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 125
},
"name": "PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm",
"symbolId": "src/privatelink:PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsInterfaceVpcEndpointAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsPacketsDroppedAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 113
},
"name": "PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarmProps",
"symbolId": "src/privatelink:PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#PrivateLinkEndpoints",
"stability": "stable",
"summary": "A construct that creates the recommended alarms for an PrivateLink InterfaceVpcEndpoint."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 237
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 231
},
"name": "PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The PacketsDropped alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 235
},
"name": "alarmPacketsDroppedList",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm"
},
"kind": "array"
}
}
}
],
"symbolId": "src/privatelink:PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "Default actions are overridden by the actions specified in the\nindividual alarm configurations.",
"stability": "stable",
"summary": "Configurations for the recommended alarms for an PrivateLink Service."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 172
},
"name": "PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the PacketsDropped alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 212
},
"name": "configPacketsDroppedAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsPacketsDroppedAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 178
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 190
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 184
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 202
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsRecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 208
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 196
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/privatelink:PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarms construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 218
},
"name": "PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The PrivateLink InterfaceVpcEndpoint to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 223
},
"name": "endpoint",
"type": {
"fqn": "aws-cdk-lib.aws_ec2.InterfaceVpcEndpoint"
}
}
],
"symbolId": "src/privatelink:PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsPacketsDroppedAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the PacketsDropped alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsPacketsDroppedAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 61
},
"name": "PrivateLinkEndpointsPacketsDroppedAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The type of the PrivateLink InterfaceVpcEndpoint."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 99
},
"name": "endpointType",
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The service name of the PrivateLink InterfaceVpcEndpoint."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 103
},
"name": "serviceName",
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"remarks": "If you want to be aware of the unhealthy status of the endpoint or endpoint service,\nyou should set the threshold low so that you get a chance to fix the issue before a huge data loss. You can use historical data to\nunderstand the tolerance for dropped packets and set the threshold accordingly.",
"stability": "stable",
"summary": "Set the threshold according to the use case."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 67
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The VPC ID of the PrivateLink InterfaceVpcEndpoint."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 95
},
"name": "vpcId",
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect if the endpoint or endpoint service is unhealthy.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 91
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- endpointId + ' - ' + subnetId + ' - PacketsDropped'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 85
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 79
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 73
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The subnets of the PrivateLink InterfaceVpcEndpoint."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 107
},
"name": "subnets",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "aws-cdk-lib.aws_ec2.ISubnet"
},
"kind": "array"
}
}
}
],
"symbolId": "src/privatelink:PrivateLinkEndpointsPacketsDroppedAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsRecommendedAlarmsMetrics": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "The recommended metrics for PrivateLink Endpoints alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkEndpointsRecommendedAlarmsMetrics",
"kind": "enum",
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 12
},
"members": [
{
"docs": {
"stability": "stable",
"summary": "Percentage of how close a file system is to reaching the I/O limit of the General Purpose performance mode."
},
"name": "PACKETS_DROPPED"
}
],
"name": "PrivateLinkEndpointsRecommendedAlarmsMetrics",
"symbolId": "src/privatelink:PrivateLinkEndpointsRecommendedAlarmsMetrics"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesAlarmBaseConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common optional configuration for the alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesAlarmBaseConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 365
},
"name": "PrivateLinkServicesAlarmBaseConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "Duration.minutes(1)",
"stability": "stable",
"summary": "The period over which the specified statistic is applied."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 371
},
"name": "period",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.Duration"
}
}
],
"symbolId": "src/privatelink:PrivateLinkServicesAlarmBaseConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesRecommendedAlarmsMetrics": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "The recommended metrics for PrivateLink Services alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesRecommendedAlarmsMetrics",
"kind": "enum",
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 354
},
"members": [
{
"docs": {
"remarks": "Increasing values could indicate\nthat there are unhealthy targets.",
"stability": "stable",
"summary": "The number of RST packets sent to endpoints by the endpoint service."
},
"name": "RST_PACKETS_SENT"
}
],
"name": "PrivateLinkServicesRecommendedAlarmsMetrics",
"symbolId": "src/privatelink:PrivateLinkServicesRecommendedAlarmsMetrics"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesRstPacketsSentAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the RstPacketsSent alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesRstPacketsSentAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 395
},
"name": "PrivateLinkServicesRstPacketsSentAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The load balancer ARN of the PrivateLink VpcEndpointService."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 428
},
"name": "loadBalancerArn",
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"remarks": "If your use case can tolerate targets being unhealthy, you can set the threshold high.\nIf the use case can’t tolerate unhealthy targets you can set the threshold very low.",
"stability": "stable",
"summary": "The threshold depends on the use case."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 400
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect unhealthy targets of an endpoint service.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 424
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- endpointServiceName + ' - ' + az + ' - RstPacketsSent'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 418
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The availability zone of the PrivateLink VpcEndpointService."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 432
},
"name": "azs",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 412
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 406
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/privatelink:PrivateLinkServicesRstPacketsSentAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesVpcEndpointServiceAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common properties for the PrivateLink VpcEndpointService alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesVpcEndpointServiceAlarmProps",
"kind": "interface",
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 377
},
"name": "PrivateLinkServicesVpcEndpointServiceAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The availability zone of the PrivateLink VpcEndpointService."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 389
},
"name": "az",
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The PrivateLink VpcEndpointService to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 381
},
"name": "endpointService",
"type": {
"fqn": "aws-cdk-lib.aws_ec2.VpcEndpointService"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The load balancer ARN of the PrivateLink VpcEndpointService."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 385
},
"name": "loadBalancerArn",
"type": {
"primitive": "string"
}
}
],
"symbolId": "src/privatelink:PrivateLinkServicesVpcEndpointServiceAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesVpcEndpointServiceRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#PrivateLinkServices",
"stability": "stable",
"summary": "A construct that creates the recommended alarms for an PrivateLink VpcEndpointService."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesVpcEndpointServiceRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 560
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesVpcEndpointServiceRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 554
},
"name": "PrivateLinkServicesVpcEndpointServiceRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The RstPacketsSent alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 558
},
"name": "alarmRstPacketsSentList",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm"
},
"kind": "array"
}
}
}
],
"symbolId": "src/privatelink:PrivateLinkServicesVpcEndpointServiceRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesVpcEndpointServiceRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "Default actions are overridden by the actions specified in the\nindividual alarm configurations.",
"stability": "stable",
"summary": "Configurations for the recommended alarms for an PrivateLink Service."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesVpcEndpointServiceRecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 495
},
"name": "PrivateLinkServicesVpcEndpointServiceRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the RstPacketsSent alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 535
},
"name": "configRstPacketsSentAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesRstPacketsSentAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 501
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 513
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 507
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 525
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesRecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 531
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 519
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/privatelink:PrivateLinkServicesVpcEndpointServiceRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesVpcEndpointServiceRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the PrivateLinkServicesVpcEndpointServiceRecommendedAlarms construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesVpcEndpointServiceRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesVpcEndpointServiceRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 541
},
"name": "PrivateLinkServicesVpcEndpointServiceRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The PrivateLink VpcEndpointService to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 546
},
"name": "endpointService",
"type": {
"fqn": "aws-cdk-lib.aws_ec2.VpcEndpointService"
}
}
],
"symbolId": "src/privatelink:PrivateLinkServicesVpcEndpointServiceRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "When you debug connection errors with a consumer of your service, you can validate whether the service is resetting connections with\nthe RstPacketsSent metric, or if something else is failing on the network path.\n\nThe alarm is triggered when the the number of reset packets exceeds the threshold.",
"stability": "stable",
"summary": "This alarm helps you detect unhealthy targets of an endpoint service based on the number of reset packets that are sent to endpoints."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 451
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 450
},
"name": "PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm",
"symbolId": "src/privatelink:PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesVpcEndpointServiceAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesRstPacketsSentAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 438
},
"name": "PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarmProps",
"symbolId": "src/privatelink:PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.Queue": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_sqs.Queue",
"docs": {
"stability": "stable",
"summary": "An extension of the SQS Queue construct that adds methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Queue",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/sqs.ts",
"line": 557
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_sqs.QueueProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/sqs.ts",
"line": 556
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that watches the age of the oldest message in the queue."
},
"locationInModule": {
"filename": "src/sqs.ts",
"line": 564
},
"name": "alarmApproximateAgeOfOldestMessage",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateAgeOfOldestMessageAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateAgeOfOldestMessageAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that watches the number of messages that are in flight."
},
"locationInModule": {
"filename": "src/sqs.ts",
"line": 574
},
"name": "alarmApproximateNumberOfMessagesNotVisible",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesNotVisibleAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesNotVisibleAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that watches the number of messages that are visible in the queue."
},
"locationInModule": {
"filename": "src/sqs.ts",
"line": 586
},
"name": "alarmApproximateNumberOfMessagesVisible",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesVisibleAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesVisibleAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that watches the number of messages that are sent."
},
"locationInModule": {
"filename": "src/sqs.ts",
"line": 598
},
"name": "alarmNumberOfMessagesSent",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsNumberOfMessagesSentAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsNumberOfMessagesSentAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates the recommended alarms for an SQS queue."
},
"locationInModule": {
"filename": "src/sqs.ts",
"line": 608
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsRecommendedAlarmsConfig"
}
}
]
}
],
"name": "Queue",
"symbolId": "src/sqs:Queue"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAlarmBaseConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common optional configuration for the alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAlarmBaseConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 59
},
"name": "RdsAlarmBaseConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "Duration.minutes(1)",
"stability": "stable",
"summary": "The period over which the specified statistic is applied."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 65
},
"name": "period",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.Duration"
}
}
],
"symbolId": "src/rds:RdsAlarmBaseConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraBinLogReplicationLagAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This alarm is used to detect whether the writer instance is in an error state and can’t replicate the source.\n\nThe alarm is triggered when the value is less than or equal to threshold.",
"stability": "stable",
"summary": "An alarm that monitors the error state of Aurora writer instance replication."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraBinLogReplicationLagAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 1009
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraBinLogReplicationLagAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/rds.ts",
"line": 1008
},
"name": "RdsAuroraBinLogReplicationLagAlarm",
"symbolId": "src/rds:RdsAuroraBinLogReplicationLagAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraBinLogReplicationLagAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the AuroraBinLogReplicationLag alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraBinLogReplicationLagAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 955
},
"name": "RdsAuroraBinLogReplicationLagAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect whether the writer instance is in an error\nstate and can’t replicate the source. This alarm is recommended only for Aurora MySQL.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 988
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- database.instanceIdentifiers[*] + ' - AuroraBinLogReplicationLag'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 981
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "2",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 975
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "2",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 969
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "-1",
"remarks": "We recommend that you use -1 as the threshold value because Aurora MySQL publishes\nthis value if the replica is in an error state.",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 963
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/rds:RdsAuroraBinLogReplicationLagAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraBinLogReplicationLagAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the RdsAuroraBinLogReplicationLag construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraBinLogReplicationLagAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraBinLogReplicationLagAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 994
},
"name": "RdsAuroraBinLogReplicationLagAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The database cluster to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 998
},
"name": "databaseCluster",
"type": {
"fqn": "aws-cdk-lib.aws_rds.IDatabaseCluster"
}
}
],
"symbolId": "src/rds:RdsAuroraBinLogReplicationLagAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#RDS",
"stability": "stable",
"summary": "A construct that creates recommended alarms for an RDS cluster."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 1392
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/rds.ts",
"line": 1381
},
"name": "RdsAuroraRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The Bin Log Replication lag alarm for the database cluster."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1390
},
"name": "alarmAuroraBinLogReplicationLag",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraBinLogReplicationLagAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The AuroraVolumeBytesLeftTotal alarm for the database cluster."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1385
},
"name": "alarmAuroraVolumeBytesLeftTotal",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraVolumeBytesLeftTotalAlarm"
}
}
],
"symbolId": "src/rds:RdsAuroraRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraRecommendedAlarmsAspect": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#RDS",
"stability": "stable",
"summary": "An aspect that applies recommended alarms for RDS clusters."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraRecommendedAlarmsAspect",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 1643
},
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraRecommendedAlarmsConfig"
}
}
]
},
"interfaces": [
"aws-cdk-lib.IAspect"
],
"kind": "class",
"locationInModule": {
"filename": "src/rds.ts",
"line": 1642
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "All aspects can visit an IConstruct."
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 1645
},
"name": "visit",
"overrides": "aws-cdk-lib.IAspect",
"parameters": [
{
"name": "node",
"type": {
"fqn": "constructs.IConstruct"
}
}
]
}
],
"name": "RdsAuroraRecommendedAlarmsAspect",
"symbolId": "src/rds:RdsAuroraRecommendedAlarmsAspect"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable"
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraRecommendedAlarmsConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 1127
},
"name": "RdsAuroraRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the AuroraBinLogReplicationLag alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1135
},
"name": "configAuroraBinLogReplicationLagAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraBinLogReplicationLagAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the AuroraVolumeBytesLeftTotal alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1131
},
"name": "configAuroraVolumeBytesLeftTotalAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraVolumeBytesLeftTotalAlarmConfig"
}
}
],
"symbolId": "src/rds:RdsAuroraRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable"
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 1150
},
"name": "RdsAuroraRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The database cluster to apply the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1154
},
"name": "databaseCluster",
"type": {
"fqn": "aws-cdk-lib.aws_rds.IDatabaseCluster"
}
}
],
"symbolId": "src/rds:RdsAuroraRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraVolumeBytesLeftTotalAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This alarm is used to detect how close the Aurora cluster is to the volume size limit. This\nalarm can prevent an out-of-space error that occurs when your cluster runs out of space.\n\nThe alarm is triggered when the remaining available space (in bytes) is less than threshold.",
"stability": "stable",
"summary": "An alarm that monitors the remaining available space (in bytes) for the cluster volume."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraVolumeBytesLeftTotalAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 911
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraVolumeBytesLeftTotalAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/rds.ts",
"line": 910
},
"name": "RdsAuroraVolumeBytesLeftTotalAlarm",
"symbolId": "src/rds:RdsAuroraVolumeBytesLeftTotalAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraVolumeBytesLeftTotalAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the AuroraVolumeBytesLeftTotal alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraVolumeBytesLeftTotalAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 856
},
"name": "RdsAuroraVolumeBytesLeftTotalAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect how close the Aurora cluster is to the volume\nsize limit. This alarm can prevent an out-of-space error that occurs when your cluster\nruns out of space. This alarm is recommended only for Aurora MySQL.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 889
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- database.instanceIdentifiers[*] + ' - AuroraVolumeBytesLeftTotal'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 881
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 875
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 869
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"remarks": "You should calculate 10%-20% of the actual size limit based on velocity and\ntrend of volume usage increase, and then use that result as the threshold value\nto proactively take action before the volume reaches its limit.",
"stability": "stable",
"summary": "The value in bytes against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 863
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/rds:RdsAuroraVolumeBytesLeftTotalAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraVolumeBytesLeftTotalAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the RdsAuroraVolumeBytesLeftTotal construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraVolumeBytesLeftTotalAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAuroraVolumeBytesLeftTotalAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 895
},
"name": "RdsAuroraVolumeBytesLeftTotalAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The database cluster to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 899
},
"name": "databaseCluster",
"type": {
"fqn": "aws-cdk-lib.aws_rds.IDatabaseCluster"
}
}
],
"symbolId": "src/rds:RdsAuroraVolumeBytesLeftTotalAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsCpuUtilizationAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the CpuUtilization alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsCpuUtilizationAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 98
},
"name": "RdsCpuUtilizationAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect consistent high CPU utilization in order to\nprevent very high response time and time-outs. If you want to check micro-bursting\nof CPU utilization you can set a lower alarm evaluation time.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 133
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- database.instanceIdentifiers[*] + ' - CpuUtilization'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 125
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 119
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 113
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "90",
"remarks": "Random spikes in CPU consumption might not hamper database performance, but sustained\nhigh CPU can hinder upcoming database requests. Depending on the overall database\nworkload, high CPU at your RDS/Aurora instance can degrade the overall performance.",
"stability": "stable",
"summary": "The percentage (0-100) value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 107
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/rds:RdsCpuUtilizationAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsDatabaseConnectionsAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the DatabaseConnections alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsDatabaseConnectionsAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 193
},
"name": "RdsDatabaseConnectionsAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "The number of connections allowed depends on the size of your DB instance class and\ndatabase engine-specific parameters related to processes/connections. You should\ncalculate a value between 90-95% of the maximum number of connections for your database\nand use that result as the threshold value.",
"stability": "stable",
"summary": "The number of connections against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 201
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm is used to help prevent rejected connections when the maximum\nnumber of DB connections is reached. This alarm is not recommended if you frequently\nchange DB instance class, because doing so changes the memory and default maximum\nnumber of connections.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 228
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- database.instanceIdentifiers[*] + ' - DatabaseConnections'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 219
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 213
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 207
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/rds:RdsDatabaseConnectionsAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsDbLoadAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the DbLoad alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsDbLoadAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 763
},
"name": "RdsDbLoadAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "The maximum vCPU value is determined by the number of vCPU (virtual CPU) cores\nfor your DB instance. Depending on the maximum vCPU, different values for the\nthreshold can be appropriate. Ideally, DB load should not go above vCPU line.",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 770
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect a high DB load. High DB load can cause\nperformance issues in the DB instance. This alarm is not applicable to serverless\nDB instances.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 796
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- database.instanceIdentifiers[*] + ' - DBLoad'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 788
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "15",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 782
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "15",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 776
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/rds:RdsDbLoadAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsFreeLocalStorageAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the FreeLocalStorage alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsFreeLocalStorageAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 381
},
"name": "RdsFreeLocalStorageAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "You should calculate about 10%-20% of the amount of storage available based on\nvelocity and trend of volume usage, and then use that result as the threshold value\nto proactively take action before the volume reaches its limit.",
"stability": "stable",
"summary": "The percentage value (0-100) against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 388
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect how close the Aurora DB instance is to reaching\nthe local storage limit, if you do not use Aurora Serverless v2 or higher. Local storage\ncan reach capacity when you store non-persistent data, such as temporary table and log\nfiles, in the local storage. This alarm can prevent an out-of-space error that occurs when\nyour DB instance runs out of local storage.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 416
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- database.instanceIdentifiers[*] + ' - FreeLocalStorage'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 406
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 400
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 394
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/rds:RdsFreeLocalStorageAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsFreeStorageSpaceAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the FreeStorageSpace alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsFreeStorageSpaceAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 478
},
"name": "RdsFreeStorageSpaceAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "The threshold value will depend on the currently allocated storage space. Typically,\nyou should calculate the value of 10 percent of the allocated storage space and use\nthat result as the threshold value.",
"stability": "stable",
"summary": "The percentage value (0-100) against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 485
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm helps prevent storage full issues. This can prevent downtime\nthat occurs when your database instance runs out of storage. We do not recommend\nusing this alarm if you have storage auto scaling enabled, or if you frequently change\nthe storage capacity of the database instance.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 512
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- database.instanceIdentifiers[*] + ' - FreeStorageSpace'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 503
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 497
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 491
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/rds:RdsFreeStorageSpaceAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsFreeableMemoryAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the FreeableMemory alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsFreeableMemoryAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 288
},
"name": "RdsFreeableMemoryAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "Depending on the workload and instance class, different values for the threshold\ncan be appropriate. Ideally, available memory should not go below 25% of total\nmemory for prolonged periods. For Aurora, you can set the threshold close to 5%,\nbecause the metric approaching 0 means that the DB instance has scaled up as much\nas it can. You can analyze the historical behavior of this metric to determine\nsensible threshold levels.",
"stability": "stable",
"summary": "The percentage value (0-100) against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 298
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm is used to help prevent running out of memory\nwhich can result in rejected connections.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 323
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- database.instanceIdentifiers[*] + ' - FreeableMemory'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 316
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "15",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 310
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "15",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 304
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/rds:RdsFreeableMemoryAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "The alarm should receive either\ninstanceIdentifier or databaseInstance.",
"stability": "stable",
"summary": "The common properties for the instance alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceAlarmProps",
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 72
},
"name": "RdsInstanceAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The database instance to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 81
},
"name": "databaseInstance",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_rds.IDatabaseInstance"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The database instance identifier to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 76
},
"name": "instanceIdentifier",
"optional": true,
"type": {
"primitive": "string"
}
}
],
"symbolId": "src/rds:RdsInstanceAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceCpuUtilizationAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This alarm is used to detect consistent high CPU utilization in order to prevent very\nhigh response time and time-outs.\n\nThe alarm is triggered when the CPU utilization exceeds the % threshold.",
"stability": "stable",
"summary": "An alarm that monitors CPU utilization for an RDS instance."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceCpuUtilizationAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 150
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceCpuUtilizationAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/rds.ts",
"line": 149
},
"name": "RdsInstanceCpuUtilizationAlarm",
"symbolId": "src/rds:RdsInstanceCpuUtilizationAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceCpuUtilizationAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the RdsInstanceCpuUtilizationAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceCpuUtilizationAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsCpuUtilizationAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 139
},
"name": "RdsInstanceCpuUtilizationAlarmProps",
"symbolId": "src/rds:RdsInstanceCpuUtilizationAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceDatabaseConnectionsAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This alarm is used to help prevent rejected connections when the maximum number of DB\nconnections is reached.\n\nThe alarm is triggered when number of connections is greater than threshold.",
"stability": "stable",
"summary": "An alarm that monitors the number of client network connections to the database instance."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceDatabaseConnectionsAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 245
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceDatabaseConnectionsAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/rds.ts",
"line": 244
},
"name": "RdsInstanceDatabaseConnectionsAlarm",
"symbolId": "src/rds:RdsInstanceDatabaseConnectionsAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceDatabaseConnectionsAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the RdsInstanceDatabaseConnectionsAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceDatabaseConnectionsAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsDatabaseConnectionsAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 234
},
"name": "RdsInstanceDatabaseConnectionsAlarmProps",
"symbolId": "src/rds:RdsInstanceDatabaseConnectionsAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceDbLoadAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This alarm helps to monitor high DB load. If the number of processes exceed the number of vCPUs,\nthe processes start queuing. When the queuing increases, the performance is impacted.\n\nThe alarm is triggered when the number of active sessions for the database is\ngreater than threshold.",
"stability": "stable",
"summary": "An alarm that monitors the number of concurrent active sessions on the database."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceDbLoadAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 814
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceDbLoadAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/rds.ts",
"line": 813
},
"name": "RdsInstanceDbLoadAlarm",
"symbolId": "src/rds:RdsInstanceDbLoadAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceDbLoadAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the RdsInstanceDbLoadAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceDbLoadAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsDbLoadAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 802
},
"name": "RdsInstanceDbLoadAlarmProps",
"symbolId": "src/rds:RdsInstanceDbLoadAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceFreeLocalStorageAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This alarm is used to detect how close the Aurora DB instance is to reaching the local storage limit.\nThis alarm can prevent an out-of-space error that occurs when your DB instance runs out of local storage.\n\nThe alarm is triggered when the amount of available local storage space (bytes) is less than threshold.",
"stability": "stable",
"summary": "An alarm that monitors the amount of available local storage space for an Aurora instance used for temporary files."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceFreeLocalStorageAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 434
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceFreeLocalStorageAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/rds.ts",
"line": 433
},
"name": "RdsInstanceFreeLocalStorageAlarm",
"symbolId": "src/rds:RdsInstanceFreeLocalStorageAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceFreeLocalStorageAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the RdsInstanceFreeLocalStorageAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceFreeLocalStorageAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsFreeLocalStorageAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 422
},
"name": "RdsInstanceFreeLocalStorageAlarmProps",
"symbolId": "src/rds:RdsInstanceFreeLocalStorageAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceFreeStorageSpaceAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This alarm helps prevent storage full issues. This can prevent downtime that occurs when your database\ninstance runs out of storage.\n\nThe alarm is triggered when the amount of available storage space (bytes) is less than threshold.",
"stability": "stable",
"summary": "An alarm that monitors the amount of available storage space for an Aurora instance."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceFreeStorageSpaceAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 529
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceFreeStorageSpaceAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/rds.ts",
"line": 528
},
"name": "RdsInstanceFreeStorageSpaceAlarm",
"symbolId": "src/rds:RdsInstanceFreeStorageSpaceAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceFreeStorageSpaceAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the RdsInstanceFreeStorageSpaceAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceFreeStorageSpaceAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsFreeStorageSpaceAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 518
},
"name": "RdsInstanceFreeStorageSpaceAlarmProps",
"symbolId": "src/rds:RdsInstanceFreeStorageSpaceAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceFreeableMemoryAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This alarm is used to help prevent running out of memory which can result in rejected connections.\n\nThe alarm is triggered when the percentage of available memory is less than threshold.",
"stability": "stable",
"summary": "An alarm that monitors the amount of available memory (RAM) on the RDS instance."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceFreeableMemoryAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 339
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceFreeableMemoryAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/rds.ts",
"line": 338
},
"name": "RdsInstanceFreeableMemoryAlarm",
"symbolId": "src/rds:RdsInstanceFreeableMemoryAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceFreeableMemoryAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the RdsInstanceFreeableMemoryAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceFreeableMemoryAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsFreeableMemoryAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 329
},
"name": "RdsInstanceFreeableMemoryAlarmProps",
"symbolId": "src/rds:RdsInstanceFreeableMemoryAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceReadLatencyAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This alarm is used to detect high read latency. Database disks normally have a low read/write latency,\nbut they can have issues that can cause high latency operations.\n\nThe alarm is triggered when the average amount of time per disk read operation (in milliseconds) is\ngreater than threshold.",
"stability": "stable",
"summary": "An alarm that monitors the average amount of time taken per disk read I/O operation."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceReadLatencyAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 625
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceReadLatencyAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/rds.ts",
"line": 624
},
"name": "RdsInstanceReadLatencyAlarm",
"symbolId": "src/rds:RdsInstanceReadLatencyAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceReadLatencyAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the RdsInstanceReadLatencyAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceReadLatencyAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsReadLatencyAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 613
},
"name": "RdsInstanceReadLatencyAlarmProps",
"symbolId": "src/rds:RdsInstanceReadLatencyAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#RDS",
"stability": "stable",
"summary": "A construct that creates recommended alarms for an RDS cluster instance."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 1203
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/rds.ts",
"line": 1162
},
"name": "RdsInstanceRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The CpuUtilization alarm for the database instance."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1166
},
"name": "alarmCpuUtilization",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceCpuUtilizationAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The DatabaseConnections alarm for the database instance."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1171
},
"name": "alarmDatabaseConnections",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceDatabaseConnectionsAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The DbLoad alarm for the database instance."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1201
},
"name": "alarmDbLoad",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceDbLoadAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The FreeableMemory alarm for the database instance."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1176
},
"name": "alarmFreeableMemory",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceFreeableMemoryAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The FreeLocalStorage alarm for the database instance."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1181
},
"name": "alarmFreeLocalStorage",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceFreeLocalStorageAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The FreeStorageSpace alarm for the database instance."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1186
},
"name": "alarmFreeStorageSpace",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceFreeStorageSpaceAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The ReadLatency alarm for the database instance."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1191
},
"name": "alarmReadLatency",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceReadLatencyAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The WriteLatency alarm for the database instance."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1196
},
"name": "alarmWriteLatency",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceWriteLatencyAlarm"
}
}
],
"symbolId": "src/rds:RdsInstanceRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceRecommendedAlarmsAspect": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#RDS",
"stability": "stable",
"summary": "An aspect that applies recommended alarms for RDS database instances."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceRecommendedAlarmsAspect",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 1619
},
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceRecommendedAlarmsConfig"
}
}
]
},
"interfaces": [
"aws-cdk-lib.IAspect"
],
"kind": "class",
"locationInModule": {
"filename": "src/rds.ts",
"line": 1618
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "All aspects can visit an IConstruct."
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 1621
},
"name": "visit",
"overrides": "aws-cdk-lib.IAspect",
"parameters": [
{
"name": "node",
"type": {
"fqn": "constructs.IConstruct"
}
}
]
}
],
"name": "RdsInstanceRecommendedAlarmsAspect",
"symbolId": "src/rds:RdsInstanceRecommendedAlarmsAspect"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable"
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceRecommendedAlarmsConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 1092
},
"name": "RdsInstanceRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the DatabaseConnections alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1100
},
"name": "configDatabaseConnectionsAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsDatabaseConnectionsAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the DbLoad alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1124
},
"name": "configDbLoadAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsDbLoadAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the FreeableMemory alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1104
},
"name": "configFreeableMemoryAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsFreeableMemoryAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the FreeLocalStorage alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1108
},
"name": "configFreeLocalStorageAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsFreeLocalStorageAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the FreeStorageSpace alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1112
},
"name": "configFreeStorageSpaceAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsFreeStorageSpaceAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the ReadLatency alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1116
},
"name": "configReadLatencyAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsReadLatencyAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the WriteLatency alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1120
},
"name": "configWriteLatencyAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsWriteLatencyAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the CpuUtilization alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1096
},
"name": "configCpuUtilizationAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsCpuUtilizationAlarmConfig"
}
}
],
"symbolId": "src/rds:RdsInstanceRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable"
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 1138
},
"name": "RdsInstanceRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The cluster instance to apply the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1147
},
"name": "databaseInstance",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_rds.IDatabaseInstance"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The cluster instance identifier to apply the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1142
},
"name": "instanceIdentifier",
"optional": true,
"type": {
"primitive": "string"
}
}
],
"symbolId": "src/rds:RdsInstanceRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceWriteLatencyAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This alarm is used to detect high write latency. Database disks normally have a low read/write latency,\nbut they can have issues that can cause high latency operations.\n\nThe alarm is triggered when the average amount of time per disk write operation (in milliseconds) is\ngreater than threshold.",
"stability": "stable",
"summary": "An alarm that monitors the average amount of time taken per disk write I/O operation."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceWriteLatencyAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/rds.ts",
"line": 720
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceWriteLatencyAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/rds.ts",
"line": 719
},
"name": "RdsInstanceWriteLatencyAlarm",
"symbolId": "src/rds:RdsInstanceWriteLatencyAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceWriteLatencyAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the RdsInstanceWriteLatencyAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceWriteLatencyAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsInstanceAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsWriteLatencyAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 708
},
"name": "RdsInstanceWriteLatencyAlarmProps",
"symbolId": "src/rds:RdsInstanceWriteLatencyAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsReadLatencyAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the ReadLatency alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsReadLatencyAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 572
},
"name": "RdsReadLatencyAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "The recommended threshold value for this alarm is highly dependent on your use case.\nRead latencies higher than 20 milliseconds are likely a cause for investigation.\nYou can also set a higher threshold if your application can have higher latency for\nread operations. Review the criticality and requirements of read latency and analyze\nthe historical behavior of this metric to determine sensible threshold levels.",
"stability": "stable",
"summary": "The value in milliseconds against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 581
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect high read latency. Database disks normally\nhave a low read/write latency, but they can have issues that can cause high latency\noperations.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 607
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- database.instanceIdentifiers[*] + ' - ReadLatency'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 599
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 593
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 587
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/rds:RdsReadLatencyAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "Default actions are overridden by the actions specified in the\nindividual alarm configurations.",
"stability": "stable",
"summary": "Configuration for RDS recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsRecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 1053
},
"name": "RdsRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1059
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1071
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1065
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1083
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsRecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1089
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 1077
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/rds:RdsRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsRecommendedAlarmsMetrics": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "The recommended metrics for RDS alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsRecommendedAlarmsMetrics",
"kind": "enum",
"locationInModule": {
"filename": "src/rds.ts",
"line": 13
},
"members": [
{
"docs": {
"stability": "stable",
"summary": "The percentage of CPU utilization for an RDS instance."
},
"name": "INSTANCE_CPU_UTILIZATION"
},
{
"docs": {
"stability": "stable",
"summary": "The number of client network connections to the database instance."
},
"name": "INSTANCE_DATABASE_CONNECTIONS"
},
{
"docs": {
"stability": "stable",
"summary": "The amount of available memory (RAM) on the RDS instance."
},
"name": "INSTANCE_FREEABLE_MEMORY"
},
{
"docs": {
"stability": "stable",
"summary": "The amount of available local storage space for an Aurora instance used for temporary files."
},
"name": "INSTANCE_FREE_LOCAL_STORAGE"
},
{
"docs": {
"stability": "stable",
"summary": "The amount of available storage space for an Aurora instance."
},
"name": "INSTANCE_FREE_STORAGE_SPACE"
},
{
"docs": {
"stability": "stable",
"summary": "The average amount of time taken per disk read I/O operation."
},
"name": "INSTANCE_READ_LATENCY"
},
{
"docs": {
"stability": "stable",
"summary": "The average amount of time taken per disk write I/O operation."
},
"name": "INSTANCE_WRITE_LATENCY"
},
{
"docs": {
"stability": "stable",
"summary": "The average active sessions (AAS) for the DB instance which shows how many sessions are concurrently active on the database."
},
"name": "INSTANCE_DB_LOAD"
},
{
"docs": {
"stability": "stable",
"summary": "The remaining available space for the cluster volume."
},
"name": "AURORA_VOLUME_BYTES_LEFT_TOTAL"
},
{
"docs": {
"stability": "stable",
"summary": "The amount of time that a binary log replica DB cluster running on Aurora MySQL lags behind the binary log replication source."
},
"name": "AURORA_BIN_LOG_REPLICATION_LAG"
}
],
"name": "RdsRecommendedAlarmsMetrics",
"symbolId": "src/rds:RdsRecommendedAlarmsMetrics"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsWriteLatencyAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the WriteLatency alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RdsWriteLatencyAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.RdsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/rds.ts",
"line": 667
},
"name": "RdsWriteLatencyAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "The recommended threshold value for this alarm is highly dependent on your use case.\nWrite latencies higher than 20 milliseconds are likely a cause for investigation.\nYou can also set a higher threshold if your application can have a higher latency\nfor write operations. Review the criticality and requirements of write latency and\nanalyze the historical behavior of this metric to determine sensible threshold levels.",
"stability": "stable",
"summary": "The value in milliseconds against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 676
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect high write latency. Although database disks\ntypically have low read/write latency, they may experience problems that cause high\nlatency operations. Monitoring this will assure you the disk latency is as low as expected.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 702
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- database.instanceIdentifiers[*] + ' - WriteLatency'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 694
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 688
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/rds.ts",
"line": 682
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/rds:RdsWriteLatencyAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ReplicationInstance": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_dms.CfnReplicationInstance",
"docs": {
"stability": "stable",
"summary": "An extension for the CfnReplicationInstance construct that provides methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ReplicationInstance",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 1249
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "aws-cdk-lib.aws_dms.CfnReplicationInstanceProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/dms.ts",
"line": 1248
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the CPU utilization for the Replication Instance."
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 1256
},
"name": "alarmCpuUtilization",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsCpuUtilizationAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceCpuUtilizationAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the FreeableMemory for the Replication Instance."
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 1266
},
"name": "alarmFreeableMemory",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsFreeableMemoryAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceFreeableMemoryAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the Free Storage Space for the Replication Instance."
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 1276
},
"name": "alarmFreeStorageSpace",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsFreeStorageSpaceAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceFreeStorageSpaceAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the Swap Usage for the Replication Instance."
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 1296
},
"name": "alarmSwapUsage",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsSwapUsageAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceSwapUsageAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the Write IOPS for the Replication Instance."
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 1286
},
"name": "alarmWriteIops",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsWriteIopsAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceWriteIopsAlarm"
}
}
},
{
"docs": {
"see": "https://aws.amazon.com/blogs/database/setting-up-amazon-cloudwatch-alarms-for-aws-dms-resources-using-the-aws-cli/",
"stability": "stable",
"summary": "Creates the recommended alarms for the DMS Replication Instance."
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 1308
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceRecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationInstanceRecommendedAlarms"
}
}
}
],
"name": "ReplicationInstance",
"symbolId": "src/dms:ReplicationInstance"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ReplicationTask": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_dms.CfnReplicationTask",
"docs": {
"stability": "stable",
"summary": "An extension for the CfnReplicationTask construct that provides methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ReplicationTask",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 1168
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ReplicationTaskProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/dms.ts",
"line": 1164
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the CDC latency from the source for the Replication Task."
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 1176
},
"name": "alarmCdcLatencySource",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsCdcLatencySourceAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskCdcLatencySourceAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the CDC latency to the target for the Replication Task."
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 1193
},
"name": "alarmCdcLatencyTarget",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsCdcLatencyTargetAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskCdcLatencyTargetAlarm"
}
}
},
{
"docs": {
"see": "https://aws.amazon.com/blogs/database/setting-up-amazon-cloudwatch-alarms-for-aws-dms-resources-using-the-aws-cli/",
"stability": "stable",
"summary": "Creates the recommended alarms for the DMS Replication Task."
},
"locationInModule": {
"filename": "src/dms.ts",
"line": 1212
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskRecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DmsReplicationTaskRecommendedAlarms"
}
}
}
],
"name": "ReplicationTask",
"properties": [
{
"docs": {
"stability": "stable"
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 1166
},
"name": "replicationInstanceIdentifier",
"type": {
"primitive": "string"
}
}
],
"symbolId": "src/dms:ReplicationTask"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.ReplicationTaskProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable"
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ReplicationTaskProps",
"interfaces": [
"aws-cdk-lib.aws_dms.CfnReplicationTaskProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/dms.ts",
"line": 1153
},
"name": "ReplicationTaskProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The identifier of the replication instance."
},
"immutable": true,
"locationInModule": {
"filename": "src/dms.ts",
"line": 1157
},
"name": "replicationInstanceIdentifier",
"type": {
"primitive": "string"
}
}
],
"symbolId": "src/dms:ReplicationTaskProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.RestApi": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_apigateway.RestApi",
"docs": {
"stability": "stable",
"summary": "An extension for the RestApi construct that provides methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.RestApi",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 808
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "aws-cdk-lib.aws_apigateway.RestApiBaseProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 807
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the number of client-side errors captured in a given period."
},
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 815
},
"name": "alarm4XXError",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGateway4XXErrorAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApi4XXErrorAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the number of server-side errors captured in a given period."
},
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 825
},
"name": "alarm5XXError",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGateway5XXErrorAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApi5XXErrorAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the total number API requests in a given period."
},
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 835
},
"name": "alarmCount",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayCountAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiCountAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates a list of alarms that monitor the total number API requests in a given period for the methods and resources specified."
},
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 857
},
"name": "alarmDetailedCount",
"parameters": [
{
"name": "props",
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiDetailedCountAlarmConfig"
},
"kind": "array"
}
}
}
],
"returns": {
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiDetailedCountAlarm"
},
"kind": "array"
}
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates a list of alarms the time between when API Gateway receives a request from a client and when it returns a response to the client for the methods and resources specified."
},
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 875
},
"name": "alarmDetailedLatency",
"parameters": [
{
"name": "props",
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiDetailedLatencyAlarmConfig"
},
"kind": "array"
}
}
}
],
"returns": {
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiDetailedLatencyAlarm"
},
"kind": "array"
}
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the time between when API Gateway receives a request from a client and when it returns a response to the client."
},
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 846
},
"name": "alarmLatency",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayLatencyAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiLatencyAlarm"
}
}
},
{
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ApiGateway",
"stability": "stable",
"summary": "Creates the recommended alarms for the ApiGateway api."
},
"locationInModule": {
"filename": "src/apigateway.ts",
"line": 893
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiRecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.ApiGatewayRestApiRecommendedAlarms"
}
}
}
],
"name": "RestApi",
"symbolId": "src/apigateway:RestApi"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket4xxErrorsAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This alarm is used to create a baseline for typical 4xx error\nrates so that you can look into any abnormalities that might\nindicate a setup issue.\n\nThe alarm is triggered when the 4xx error rate exceeds the % threshold.",
"stability": "stable",
"summary": "An alarm that monitors the 4xx errors for an S3 bucket."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket4xxErrorsAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/s3.ts",
"line": 98
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket4xxErrorsAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/s3.ts",
"line": 97
},
"name": "S3Bucket4xxErrorsAlarm",
"symbolId": "src/s3:S3Bucket4xxErrorsAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket4xxErrorsAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the 4xx errors alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket4xxErrorsAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.S3BucketHttpErrorsAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/s3.ts",
"line": 57
},
"name": "S3Bucket4xxErrorsAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm helps us report the total number of 4xx error status codes\nthat are made in response to client requests. 403 error codes might indicate an\nincorrect IAM policy, and 404 error codes might indicate mis-behaving client application,\nfor example. Enabling S3 server access logging on a temporary basis will help you to\npinpoint the issue's origin using the fields HTTP status and Error Code. To understand\nmore about the error code, see Error Responses\n(https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html).",
"stability": "stable",
"summary": "The alarm description."
},
"immutable": true,
"locationInModule": {
"filename": "src/s3.ts",
"line": 75
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- bucket.bucketName + ' - 4xxErrors'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/s3.ts",
"line": 63
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
}
],
"symbolId": "src/s3:S3Bucket4xxErrorsAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket4xxErrorsAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the S3Bucket4xxErrorsAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket4xxErrorsAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket4xxErrorsAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/s3.ts",
"line": 81
},
"name": "S3Bucket4xxErrorsAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The S3 bucket to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/s3.ts",
"line": 85
},
"name": "bucket",
"type": {
"fqn": "aws-cdk-lib.aws_s3.IBucket"
}
}
],
"symbolId": "src/s3:S3Bucket4xxErrorsAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket5xxErrorsAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This alarm can help to detect if the application is\nexperiencing issues due to 5xx errors.\n\nThe alarm is triggered when the 5xx error rate exceeds the % threshold.",
"stability": "stable",
"summary": "An alarm that monitors the 5xx errors for an S3 bucket."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket5xxErrorsAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/s3.ts",
"line": 178
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket5xxErrorsAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/s3.ts",
"line": 177
},
"name": "S3Bucket5xxErrorsAlarm",
"symbolId": "src/s3:S3Bucket5xxErrorsAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket5xxErrorsAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the 5xx errors alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket5xxErrorsAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.S3BucketHttpErrorsAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/s3.ts",
"line": 139
},
"name": "S3Bucket5xxErrorsAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm helps you detect a high number of server-side errors. These errors indicate\nthat a client made a request that the server couldn’t complete. This can help you correlate the\nissue your application is facing because of S3. For more information to help you efficiently\nhandle or reduce errors, see Optimizing performance design patterns\n(https://docs.aws.amazon.com/AmazonS3/latest/userguide/optimizing-performance-design-patterns.html#optimizing-performance-timeouts-retries).\nErrors might also be caused by an the issue with S3, check AWS service health dashboard for the status of Amazon S3 in your Region.",
"stability": "stable",
"summary": "The alarm description."
},
"immutable": true,
"locationInModule": {
"filename": "src/s3.ts",
"line": 156
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- bucket.bucketName + ' - 5xxErrors'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/s3.ts",
"line": 145
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
}
],
"symbolId": "src/s3:S3Bucket5xxErrorsAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket5xxErrorsAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the S3Bucket5xxErrorsAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket5xxErrorsAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket5xxErrorsAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/s3.ts",
"line": 162
},
"name": "S3Bucket5xxErrorsAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The S3 bucket to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/s3.ts",
"line": 166
},
"name": "bucket",
"type": {
"fqn": "aws-cdk-lib.aws_s3.IBucket"
}
}
],
"symbolId": "src/s3:S3Bucket5xxErrorsAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.S3BucketHttpErrorsAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The optional configuration for the 4xx and 5xx error alarms for an S3 bucket."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3BucketHttpErrorsAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/s3.ts",
"line": 27
},
"name": "S3BucketHttpErrorsAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "15",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/s3.ts",
"line": 51
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "15",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/s3.ts",
"line": 45
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "Duration.minutes(1)",
"stability": "stable",
"summary": "The period over which the specified statistic is applied."
},
"immutable": true,
"locationInModule": {
"filename": "src/s3.ts",
"line": 33
},
"name": "period",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.Duration"
}
},
{
"abstract": true,
"docs": {
"default": "0.05",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/s3.ts",
"line": 39
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/s3:S3BucketHttpErrorsAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.S3RecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#S3",
"stability": "stable",
"summary": "A construct that creates the recommended alarms for an S3 bucket."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3RecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/s3.ts",
"line": 291
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3RecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/s3.ts",
"line": 281
},
"name": "S3RecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The 4xx errors alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/s3.ts",
"line": 285
},
"name": "alarm4xxErrors",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket4xxErrorsAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The 5xx errors alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/s3.ts",
"line": 289
},
"name": "alarm5xxErrors",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket5xxErrorsAlarm"
}
}
],
"symbolId": "src/s3:S3RecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.S3RecommendedAlarmsAspect": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#S3",
"stability": "stable",
"summary": "Configures the recommended alarms for an S3 bucket."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3RecommendedAlarmsAspect",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/s3.ts",
"line": 384
},
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3RecommendedAlarmsConfig"
}
}
]
},
"interfaces": [
"aws-cdk-lib.IAspect"
],
"kind": "class",
"locationInModule": {
"filename": "src/s3.ts",
"line": 383
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "All aspects can visit an IConstruct."
},
"locationInModule": {
"filename": "src/s3.ts",
"line": 386
},
"name": "visit",
"overrides": "aws-cdk-lib.IAspect",
"parameters": [
{
"name": "node",
"type": {
"fqn": "constructs.IConstruct"
}
}
]
}
],
"name": "S3RecommendedAlarmsAspect",
"symbolId": "src/s3:S3RecommendedAlarmsAspect"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.S3RecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "Default actions are overridden by the actions specified in the\nindividual alarm configurations.",
"stability": "stable",
"summary": "Configurations for the recommended alarms for an S3 bucket."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3RecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/s3.ts",
"line": 222
},
"name": "S3RecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the 4xx errors alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/s3.ts",
"line": 262
},
"name": "config4xxErrorsAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket4xxErrorsAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the 5xx errors alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/s3.ts",
"line": 266
},
"name": "config5xxErrorsAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3Bucket5xxErrorsAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/s3.ts",
"line": 228
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/s3.ts",
"line": 240
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/s3.ts",
"line": 234
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/s3.ts",
"line": 252
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3RecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/s3.ts",
"line": 258
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/s3.ts",
"line": 246
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/s3:S3RecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.S3RecommendedAlarmsMetrics": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "The recommended metrics for S3 bucket alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3RecommendedAlarmsMetrics",
"kind": "enum",
"locationInModule": {
"filename": "src/s3.ts",
"line": 13
},
"members": [
{
"docs": {
"stability": "stable",
"summary": "4xxErrors are errors (4xx error codes) that are made in response to client requests."
},
"name": "ERRORS_4XX"
},
{
"docs": {
"stability": "stable",
"summary": "5xxErrors are server errors (5xx error codes) that are made in response to client requests."
},
"name": "ERRORS_5XX"
}
],
"name": "S3RecommendedAlarmsMetrics",
"symbolId": "src/s3:S3RecommendedAlarmsMetrics"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.S3RecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable"
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.S3RecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.S3RecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/s3.ts",
"line": 269
},
"name": "S3RecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The S3 bucket to apply the recommended alarms to."
},
"immutable": true,
"locationInModule": {
"filename": "src/s3.ts",
"line": 273
},
"name": "bucket",
"type": {
"fqn": "aws-cdk-lib.aws_s3.IBucket"
}
}
],
"symbolId": "src/s3:S3RecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SfAlarmBaseConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common optional configuration for the alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfAlarmBaseConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/states.ts",
"line": 36
},
"name": "SfAlarmBaseConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "Duration.minutes(1)",
"stability": "stable",
"summary": "The period over which the specified statistic is applied."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 42
},
"name": "period",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.Duration"
}
}
],
"symbolId": "src/states:SfAlarmBaseConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SfRecommendedAlarmsAspect": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "Configures the alarms for an StepFunctions StateMachine."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfRecommendedAlarmsAspect",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/states.ts",
"line": 685
},
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineRecommendedAlarmsConfig"
}
}
]
},
"interfaces": [
"aws-cdk-lib.IAspect"
],
"kind": "class",
"locationInModule": {
"filename": "src/states.ts",
"line": 684
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "All aspects can visit an IConstruct."
},
"locationInModule": {
"filename": "src/states.ts",
"line": 687
},
"name": "visit",
"overrides": "aws-cdk-lib.IAspect",
"parameters": [
{
"name": "node",
"type": {
"fqn": "constructs.IConstruct"
}
}
]
}
],
"name": "SfRecommendedAlarmsAspect",
"symbolId": "src/states:SfRecommendedAlarmsAspect"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SfRecommendedAlarmsMetrics": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "The recommended metrics for StepFunctions alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfRecommendedAlarmsMetrics",
"kind": "enum",
"locationInModule": {
"filename": "src/states.ts",
"line": 13
},
"members": [
{
"docs": {
"stability": "stable",
"summary": "Interval, in milliseconds, between the time the execution starts and the time it closes."
},
"name": "EXECUTION_TIME"
},
{
"docs": {
"remarks": "This is related to\nStateTransition throttling. For more information, see Quotas related to state throttling.",
"stability": "stable",
"summary": "Number of StateEntered events and retries that have been throttled."
},
"name": "EXECUTION_THROTTLED"
},
{
"docs": {
"stability": "stable",
"summary": "Number of failed executions."
},
"name": "EXECUTIONS_FAILED"
},
{
"docs": {
"stability": "stable",
"summary": "Number of executions that time out for any reason."
},
"name": "EXECUTIONS_TIMED_OUT"
}
],
"name": "SfRecommendedAlarmsMetrics",
"symbolId": "src/states:SfRecommendedAlarmsMetrics"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common properties for the StepFunctions StateMachine alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineAlarmProps",
"kind": "interface",
"locationInModule": {
"filename": "src/states.ts",
"line": 48
},
"name": "SfStateMachineAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The StateMachine to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 52
},
"name": "stateMachine",
"type": {
"fqn": "aws-cdk-lib.aws_stepfunctions.StateMachine"
}
}
],
"symbolId": "src/states:SfStateMachineAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionThrottledAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "Monitoring this can help you identify when you are hitting this limits, which could signal that adjustments need to be made either in\nthe process design or in the service limits themselves.\n\nThe alarm is triggered when the number of executions throttled exceed the threshold.",
"stability": "stable",
"summary": "The ExecutionThrottled metric tracks the number of times state machine executions are throttled due to exceeding AWS service limits."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionThrottledAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/states.ts",
"line": 193
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionThrottledAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/states.ts",
"line": 192
},
"name": "SfStateMachineExecutionThrottledAlarm",
"symbolId": "src/states:SfStateMachineExecutionThrottledAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionThrottledAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the ExecutionThrottled alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionThrottledAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SfAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/states.ts",
"line": 144
},
"name": "SfStateMachineExecutionThrottledAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect throttled executions due to exceeding AWS service limits.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 176
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- stateMachineName + ' - ExecutionThrottled'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 170
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 164
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 158
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"remarks": "Monitoring this can help you identify when you are hitting this limits, which could signal that adjustments need to be made either in\nthe process design or in the service limits themselves.",
"stability": "stable",
"summary": "The ExecutionThrottled metric tracks the number of times state machine executions are throttled due to exceeding AWS service limits."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 152
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/states:SfStateMachineExecutionThrottledAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionThrottledAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the SfStateMachineExecutionThrottledAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionThrottledAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionThrottledAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/states.ts",
"line": 182
},
"name": "SfStateMachineExecutionThrottledAlarmProps",
"symbolId": "src/states:SfStateMachineExecutionThrottledAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionTimeAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "A sudden increase in execution time might indicate issues with the steps of the resources they interact with.\n\nThe alarm is triggered when the time in milliseconds exceed the threshold.",
"stability": "stable",
"summary": "This metric can be a valuable tool for early detection of issues that might not be immediately apparent from other metrics."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionTimeAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/states.ts",
"line": 105
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionTimeAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/states.ts",
"line": 104
},
"name": "SfStateMachineExecutionTimeAlarm",
"symbolId": "src/states:SfStateMachineExecutionTimeAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionTimeAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the ExecutionTime alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionTimeAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SfAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/states.ts",
"line": 58
},
"name": "SfStateMachineExecutionTimeAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "None",
"remarks": "Consider setting a threshold (in milliseconds) that is appropriate for the expected execution time of the state machine.",
"stability": "stable",
"summary": "A sudden increase in execution time might indicate issues with the steps of the resources they interact with."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 65
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect sudden increases in execution time..",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 89
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- stateMachineName + ' - ExecutionTime'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 83
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 77
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 71
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/states:SfStateMachineExecutionTimeAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionTimeAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the SfStateMachineExecutionTimeAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionTimeAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionTimeAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/states.ts",
"line": 95
},
"name": "SfStateMachineExecutionTimeAlarmProps",
"symbolId": "src/states:SfStateMachineExecutionTimeAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsFailedAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This is crucial for identifying workflows that are\nnot performing as expected and require attention.\n\nBy monitoring the failures, developers can proactively identify and resolve issues before they impact the business operations. This reduces\ndowntime and improves the overall stability of applications.\n\nThe alarm is triggered when the number of failed executions exceed the threshold.",
"stability": "stable",
"summary": "It helps in tracking the number of executions that fail in AWS Step Functions."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsFailedAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/states.ts",
"line": 282
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsFailedAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/states.ts",
"line": 281
},
"name": "SfStateMachineExecutionsFailedAlarm",
"symbolId": "src/states:SfStateMachineExecutionsFailedAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsFailedAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the ExecutionsFailed alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsFailedAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SfAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/states.ts",
"line": 232
},
"name": "SfStateMachineExecutionsFailedAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect workflows that are not working as expected.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 264
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- stateMachineName + ' - ExecutionsFailed'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 258
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 252
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 246
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"remarks": "This is crucial for identifying workflows that are\nnot performing as expected and require attention. By monitoring the failures, developers can proactively identify and resolve issues\nbefore they impact the business operations. This reduces downtime and improves the overall stability of applications.",
"stability": "stable",
"summary": "It helps in tracking the number of executions that fail in AWS Step Functions."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 240
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/states:SfStateMachineExecutionsFailedAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsFailedAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the SfStateMachineExecutionsFailedAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsFailedAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsFailedAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/states.ts",
"line": 270
},
"name": "SfStateMachineExecutionsFailedAlarmProps",
"symbolId": "src/states:SfStateMachineExecutionsFailedAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsTimedOutAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This can indicate problems like poor configuration, inadequate resource allocation, or issues in the called services that need addressing.\n\nThe alarm is triggered when the number of timed out executions exceed the threshold.",
"stability": "stable",
"summary": "This alarm helps in identifying timeouts in state machine executions."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsTimedOutAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/states.ts",
"line": 369
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsTimedOutAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/states.ts",
"line": 368
},
"name": "SfStateMachineExecutionsTimedOutAlarm",
"symbolId": "src/states:SfStateMachineExecutionsTimedOutAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsTimedOutAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the ExecutionsTimedOut alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsTimedOutAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SfAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/states.ts",
"line": 321
},
"name": "SfStateMachineExecutionsTimedOutAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm helps in identifying timeouts in state machine executions due to poor configuration, inadequate resource allocation,\nor issues in the called services that need addressing.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 353
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- stateMachineName + ' - ExecutionsTimedOut'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 346
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 340
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 334
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "It helps in identifying timeouts in state machine executions, which can indicate problems like poor configuration, inadequate resource allocation, or issues in the called services that need addressing."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 328
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/states:SfStateMachineExecutionsTimedOutAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsTimedOutAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the SfStateMachineExecutionsTimedOutAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsTimedOutAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsTimedOutAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/states.ts",
"line": 359
},
"name": "SfStateMachineExecutionsTimedOutAlarmProps",
"symbolId": "src/states:SfStateMachineExecutionsTimedOutAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"stability": "stable",
"summary": "A construct that creates the recommended alarms for an StepFunctions StateMachine."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/states.ts",
"line": 500
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/states.ts",
"line": 479
},
"name": "SfStateMachineRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The ExecutionsFailed alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 493
},
"name": "alarmExecutionsFailed",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsFailedAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The ExecutionsTimedOut alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 498
},
"name": "alarmExecutionsTimedOut",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsTimedOutAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The ExecutionThrottled alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 488
},
"name": "alarmExecutionThrottled",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionThrottledAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The ExecutionTime alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 483
},
"name": "alarmExecutionTime",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionTimeAlarm"
}
}
],
"symbolId": "src/states:SfStateMachineRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "Default actions are overridden by the actions specified in the individual alarm configurations.",
"stability": "stable",
"summary": "Configurations for the recommended alarms for an StepFunctions Service."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineRecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/states.ts",
"line": 411
},
"name": "SfStateMachineRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the ExecutionTime alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 451
},
"name": "configExecutionTimeAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionTimeAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the ExecutionsFailed alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 459
},
"name": "configExecutionsFailedAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsFailedAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the ExecutionsFailed alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 463
},
"name": "configExecutionsTimedOutAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsTimedOutAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the ExecutionThrottled alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 455
},
"name": "configExecutionThrottledAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionThrottledAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 417
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 429
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 423
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 441
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfRecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 447
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 435
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/states:SfStateMachineRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the SfStateMachineRecommendedAlarms construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/states.ts",
"line": 469
},
"name": "SfStateMachineRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The EFS StateMachine to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/states.ts",
"line": 473
},
"name": "stateMachine",
"type": {
"fqn": "aws-cdk-lib.aws_stepfunctions.StateMachine"
}
}
],
"symbolId": "src/states:SfStateMachineRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsAlarmBaseConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable"
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsAlarmBaseConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sns.ts",
"line": 44
},
"name": "SnsAlarmBaseConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 62
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "5",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 56
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "Duration.minutes(1)",
"stability": "stable",
"summary": "The period over which the specified statistic is applied."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 50
},
"name": "period",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.Duration"
}
}
],
"symbolId": "src/sns:SnsAlarmBaseConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfMessagesPublishedAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This alarm helps you proactively monitor and detect significant drops in\nnotification publishing. This helps you identify potential issues with\nyour application or business processes, so that you can take appropriate\nactions to maintain the expected flow of notifications. You should create\nthis alarm if you expect your system to have a minimum traffic that it\nis serving.\n\nThe alarm is triggered when the number of messages published to the topic\nis less than the specified threshold.",
"stability": "stable",
"summary": "An alarm that monitors the number of messages published to an SNS topic."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfMessagesPublishedAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/sns.ts",
"line": 116
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfMessagesPublishedAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/sns.ts",
"line": 115
},
"name": "SnsNumberOfMessagesPublishedAlarm",
"symbolId": "src/sns:SnsNumberOfMessagesPublishedAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfMessagesPublishedAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the NumberOfMessagesPublished alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfMessagesPublishedAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sns.ts",
"line": 68
},
"name": "SnsNumberOfMessagesPublishedAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "The number of messages published should be in line with the expected number of\npublished messages for your application. You can also analyze the historical data,\ntrends and traffic to find the right threshold.",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 76
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm can detect when the number of SNS messages published is too low.\nFor troubleshooting, check why the publishers are sending less traffic.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 89
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- topic.topicName + ' - NumberOfMessagesPublished'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 82
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
}
],
"symbolId": "src/sns:SnsNumberOfMessagesPublishedAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfMessagesPublishedAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the SnsNumberOfMessagesPublishedAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfMessagesPublishedAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfMessagesPublishedAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sns.ts",
"line": 95
},
"name": "SnsNumberOfMessagesPublishedAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The SNS topic for which to create the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 99
},
"name": "topic",
"type": {
"fqn": "aws-cdk-lib.aws_sns.ITopic"
}
}
],
"symbolId": "src/sns:SnsNumberOfMessagesPublishedAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsDeliveredAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This alarm helps you detect a drop in the volume of messages delivered.\nYou should create this alarm if you expect your system to have a\nminimum traffic that it is serving.\n\nThe alarm is triggered when the number of messages delivered by the topic\nis less than the specified threshold.",
"stability": "stable",
"summary": "An alarm that monitors the number of notifications delivered by an SNS topic."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsDeliveredAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/sns.ts",
"line": 191
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsDeliveredAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/sns.ts",
"line": 190
},
"name": "SnsNumberOfNotificationsDeliveredAlarm",
"symbolId": "src/sns:SnsNumberOfNotificationsDeliveredAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsDeliveredAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the NumberOfNotificationsDelivered alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsDeliveredAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sns.ts",
"line": 145
},
"name": "SnsNumberOfNotificationsDeliveredAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "The number of messages delivered should be in line with the expected number of\nmessages produced and the number of consumers. You can also analyze the historical\ndata, trends and traffic to find the right threshold.",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 153
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm can detect when the number of SNS messages delivered is too low.\nThis could be because of unintentional unsubscribing of an endpoint, or because of\nan SNS event that causes messages to experience delay.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 167
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- topic.topicName + ' - NumberOfNotificationsDelivered'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 159
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
}
],
"symbolId": "src/sns:SnsNumberOfNotificationsDeliveredAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsDeliveredAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the SnsNumberOfNotificationsDeliveredAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsDeliveredAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsDeliveredAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sns.ts",
"line": 173
},
"name": "SnsNumberOfNotificationsDeliveredAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The SNS topic for which to create the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 177
},
"name": "topic",
"type": {
"fqn": "aws-cdk-lib.aws_sns.ITopic"
}
}
],
"symbolId": "src/sns:SnsNumberOfNotificationsDeliveredAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This alarm helps you proactively find issues with the delivery of notifications\nand take appropriate actions to address them.\n\nThe alarm is triggered when the number of messages failed by the topic\nis greater than the specified threshold.",
"stability": "stable",
"summary": "An alarm that monitors the number of notifications failed by an SNS topic."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/sns.ts",
"line": 268
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/sns.ts",
"line": 267
},
"name": "SnsNumberOfNotificationsFailedAlarm",
"symbolId": "src/sns:SnsNumberOfNotificationsFailedAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the NumberOfNotificationsFailed alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sns.ts",
"line": 220
},
"name": "SnsNumberOfNotificationsFailedAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "The recommended threshold value for this alarm is highly dependent on the\nimpact of failed notifications. Review the SLAs provided to your end users,\nfault tolerance and criticality of notifications and analyze historical data,\nand then select a threshold accordingly. The number of notifications failed\nshould be 0 for topics that have only SQS, Lambda or Firehose subscriptions.",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 230
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm can detect when the number of failed SNS messages is too high.\nTo troubleshoot failed notifications, enable logging to CloudWatch Logs. Checking\nthe logs can help you find which subscribers are failing, as well as the status\ncodes they are returning.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 245
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- topic.topicName + ' - NumberOfNotificationsFailed'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 236
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
}
],
"symbolId": "src/sns:SnsNumberOfNotificationsFailedAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the SnsNumberOfNotificationsFailedAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sns.ts",
"line": 251
},
"name": "SnsNumberOfNotificationsFailedAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The SNS topic for which to create the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 255
},
"name": "topic",
"type": {
"fqn": "aws-cdk-lib.aws_sns.ITopic"
}
}
],
"symbolId": "src/sns:SnsNumberOfNotificationsFailedAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedToRedriveToDlqAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "The alarm is used to detect messages that couldn't be moved to a dead-letter\nqueue.\n\nThe alarm is triggered when the number of messages failed to redrive to the\ndead-letter queue is greater than the specified threshold.",
"stability": "stable",
"summary": "An alarm that monitors the number of notifications failed to redrive to the dead-letter queue."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedToRedriveToDlqAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/sns.ts",
"line": 600
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedToRedriveToDlqAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/sns.ts",
"line": 599
},
"name": "SnsNumberOfNotificationsFailedToRedriveToDlqAlarm",
"symbolId": "src/sns:SnsNumberOfNotificationsFailedToRedriveToDlqAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedToRedriveToDlqAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the NumberOfNotificationsFailedToRedriveToDlq alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedToRedriveToDlqAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sns.ts",
"line": 550
},
"name": "SnsNumberOfNotificationsFailedToRedriveToDlqAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm helps to monitor messages that couldn't be moved to a dead-letter\nqueue. Check whether your dead-letter queue exists and that it's configured correctly.\nAlso, verify that SNS has permissions to access the dead-letter queue. Refer to the\ndead-letter queue documentation (https://docs.aws.amazon.com/sns/latest/dg/sns-dead-letter-queues.html)\nto learn more.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 576
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- topic.topicName + ' - NumberOfNotificationsFailedToRedriveToDlq'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 566
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "0",
"remarks": "It's almost always a mistake if messages can't be moved to the dead-letter queue.\nThe recommendation for the threshold is 0, meaning all messages that fail processing\nmust be able to reach the dead-letter queue when the queue has been configured.",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 560
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/sns:SnsNumberOfNotificationsFailedToRedriveToDlqAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedToRedriveToDlqAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the SnsNumberOfNotificationsFailedToRedriveToDlqAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedToRedriveToDlqAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedToRedriveToDlqAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sns.ts",
"line": 582
},
"name": "SnsNumberOfNotificationsFailedToRedriveToDlqAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The SNS topic for which to create the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 586
},
"name": "topic",
"type": {
"fqn": "aws-cdk-lib.aws_sns.ITopic"
}
}
],
"symbolId": "src/sns:SnsNumberOfNotificationsFailedToRedriveToDlqAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "The alarm is used to detect if the published messages are not valid or\nif inappropriate filters have been applied to a subscriber.\n\nThe alarm is triggered when the number of messages filtered out due to\ninvalid attributes is greater than the specified threshold.",
"stability": "stable",
"summary": "An alarm that monitors the number of notifications filtered out due to invalid attributes."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/sns.ts",
"line": 348
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/sns.ts",
"line": 347
},
"name": "SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm",
"symbolId": "src/sns:SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the NumberOfNotificationsFilteredOutInvalidAttributes alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sns.ts",
"line": 299
},
"name": "SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm helps to monitor and resolve potential problems with the publisher or subscribers.\nCheck if a publisher is publishing messages with invalid attributes or if an inappropriate filter is\napplied to a subscriber. You can also analyze CloudWatch Logs to help find the root cause of the issue.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 323
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- topic.topicName + ' - NumberOfNotificationsFilteredOut-InvalidAttributes'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 315
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "0",
"remarks": "Invalid attributes are almost always a mistake by the publisher. We recommend\nto set the threshold to 0 because invalid attributes are not expected in a\nhealthy system.",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 309
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/sns:SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sns.ts",
"line": 329
},
"name": "SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The SNS topic for which to create the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 334
},
"name": "topic",
"type": {
"fqn": "aws-cdk-lib.aws_sns.ITopic"
}
}
],
"symbolId": "src/sns:SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "The alarm is used to detect if the published messages are not valid or\nif inappropriate filters have been applied to a subscriber.\n\nThe alarm is triggered when the number of messages filtered out due to\ninvalid message body is greater than the specified threshold.",
"stability": "stable",
"summary": "An alarm that monitors the number of notifications filtered out due to invalid message body."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/sns.ts",
"line": 429
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/sns.ts",
"line": 428
},
"name": "SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm",
"symbolId": "src/sns:SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the NumberOfNotificationsFilteredOutInvalidMessageBody alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sns.ts",
"line": 379
},
"name": "SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm helps to monitor and resolve potential problems with the\npublisher or subscribers. Check if a publisher is publishing messages with\ninvalid message bodies, or if an inappropriate filter is applied to a subscriber.\nYou can also analyze CloudWatch Logs to help find the root cause of the issue.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 404
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- topic.topicName + ' - NumberOfNotificationsFilteredOut-InvalidMessageBody'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 395
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "0",
"remarks": "Invalid message bodies are almost always a mistake by the publisher.\nWe recommend to set the threshold to 0 because invalid message bodies\nare not expected in a healthy system.",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 389
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/sns:SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sns.ts",
"line": 410
},
"name": "SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The SNS topic for which to create the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 415
},
"name": "topic",
"type": {
"fqn": "aws-cdk-lib.aws_sns.ITopic"
}
}
],
"symbolId": "src/sns:SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsRedrivenToDlqAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "The alarm is used to detect messages that moved to a dead-letter\nqueue. We recommend that you create this alarm when SNS is coupled\nwith SQS, Lambda or Firehose.\n\nThe alarm is triggered when the number of messages redriven to the\ndead-letter queue is greater than the specified threshold.",
"stability": "stable",
"summary": "An alarm that monitors the number of notifications redriven to the dead-letter queue."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsRedrivenToDlqAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/sns.ts",
"line": 515
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsRedrivenToDlqAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/sns.ts",
"line": 514
},
"name": "SnsNumberOfNotificationsRedrivenToDlqAlarm",
"symbolId": "src/sns:SnsNumberOfNotificationsRedrivenToDlqAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsRedrivenToDlqAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the NumberOfNotificationsRedrivenToDlq alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsRedrivenToDlqAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sns.ts",
"line": 466
},
"name": "SnsNumberOfNotificationsRedrivenToDlqAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm helps to monitor the number of messages that are moved to a dead-letter queue.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 490
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- topic.topicName + ' - NumberOfNotificationsRedrivenToDlq'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 484
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "0",
"remarks": "In a healthy system of any subscriber type, messages should not be moved\nto the dead-letter queue. We recommend that you be notified if any messages\nland in the queue, so that you can identify and address the root cause,\nand potentially redrive the messages in the dead-letter queue to prevent\ndata loss.",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 478
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/sns:SnsNumberOfNotificationsRedrivenToDlqAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsRedrivenToDlqAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the SnsNumberOfNotificationsRedrivenToDlqAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsRedrivenToDlqAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsRedrivenToDlqAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sns.ts",
"line": 496
},
"name": "SnsNumberOfNotificationsRedrivenToDlqAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The SNS topic for which to create the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 500
},
"name": "topic",
"type": {
"fqn": "aws-cdk-lib.aws_sns.ITopic"
}
}
],
"symbolId": "src/sns:SnsNumberOfNotificationsRedrivenToDlqAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#SNS",
"stability": "stable",
"summary": "A construct that creates recommended alarms for an SNS topic."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/sns.ts",
"line": 744
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/sns.ts",
"line": 714
},
"name": "SnsRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The NumberOfMessagesPublished alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 718
},
"name": "alarmNumberOfMessagesPublished",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfMessagesPublishedAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The NumberOfNotificationsDelivered alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 722
},
"name": "alarmNumberOfNotificationsDelivered",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsDeliveredAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The NumberOfNotificationsFailed alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 726
},
"name": "alarmNumberOfNotificationsFailed",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The NumberOfNotificationsFailedToRedriveToDlq alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 742
},
"name": "alarmNumberOfNotificationsFailedToRedriveToDlq",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedToRedriveToDlqAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The NumberOfNotificationsFilteredOutInvalidAttributes alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 730
},
"name": "alarmNumberOfNotificationsFilteredOutInvalidAttributes",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The NumberOfNotificationsFilteredOutInvalidMessageBody alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 734
},
"name": "alarmNumberOfNotificationsFilteredOutInvalidMessageBody",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The NumberOfNotificationsRedrivenToDlq alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 738
},
"name": "alarmNumberOfNotificationsRedrivenToDlq",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsRedrivenToDlqAlarm"
}
}
],
"symbolId": "src/sns:SnsRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsRecommendedAlarmsAspect": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#SNS",
"stability": "stable",
"summary": "An aspect that applies recommended alarms to SNS topics."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsRecommendedAlarmsAspect",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/sns.ts",
"line": 1001
},
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsRecommendedAlarmsConfig"
}
}
]
},
"interfaces": [
"aws-cdk-lib.IAspect"
],
"kind": "class",
"locationInModule": {
"filename": "src/sns.ts",
"line": 1000
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "All aspects can visit an IConstruct."
},
"locationInModule": {
"filename": "src/sns.ts",
"line": 1003
},
"name": "visit",
"overrides": "aws-cdk-lib.IAspect",
"parameters": [
{
"name": "node",
"type": {
"fqn": "constructs.IConstruct"
}
}
]
}
],
"name": "SnsRecommendedAlarmsAspect",
"symbolId": "src/sns:SnsRecommendedAlarmsAspect"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable"
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsRecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/sns.ts",
"line": 635
},
"name": "SnsRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the NumberOfMessagesPublished alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 675
},
"name": "configNumberOfMessagesPublishedAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfMessagesPublishedAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the NumberOfNotificationsDelivered alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 679
},
"name": "configNumberOfNotificationsDeliveredAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsDeliveredAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the NumberOfNotificationsFailed alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 683
},
"name": "configNumberOfNotificationsFailedAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the NumberOfNotificationsFailedToRedriveToDlq alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 699
},
"name": "configNumberOfNotificationsFailedToRedriveToDlqAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedToRedriveToDlqAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the NumberOfNotificationsFilteredOutInvalidAttributes alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 687
},
"name": "configNumberOfNotificationsFilteredOutInvalidAttributesAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the NumberOfNotificationsFilteredOutInvalidMessageBody alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 691
},
"name": "configNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the NumberOfNotificationsRedrivenToDlq alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 695
},
"name": "configNumberOfNotificationsRedrivenToDlqAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsRedrivenToDlqAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 641
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 653
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 647
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 665
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsRecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 671
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 659
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/sns:SnsRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsRecommendedAlarmsMetrics": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "The recommended metrics for SNS topic alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsRecommendedAlarmsMetrics",
"kind": "enum",
"locationInModule": {
"filename": "src/sns.ts",
"line": 13
},
"members": [
{
"docs": {
"stability": "stable",
"summary": "The number of messages published to the topic."
},
"name": "NUMBER_OF_MESSAGES_PUBLISHED"
},
{
"docs": {
"stability": "stable",
"summary": "The number of notifications delivered."
},
"name": "NUMBER_OF_NOTIFICATIONS_DELIVERED"
},
{
"docs": {
"stability": "stable",
"summary": "The number of notifications failed."
},
"name": "NUMBER_OF_NOTIFICATIONS_FAILED"
},
{
"docs": {
"stability": "stable",
"summary": "The number of notifications filtered out due to invalid attributes."
},
"name": "NUMBER_OF_NOTIFICATIONS_FILTERED_OUT_INVALID_ATTRIBUTES"
},
{
"docs": {
"stability": "stable",
"summary": "The number of notifications filtered out due to invalid message body."
},
"name": "NUMBER_OF_NOTIFICATIONS_FILTERED_OUT_INVALID_MESSAGE_BODY"
},
{
"docs": {
"stability": "stable",
"summary": "The number of notifications redriven to the dead-letter queue."
},
"name": "NUMBER_OF_NOTIFICATIONS_REDRIVEN_TO_DLQ"
},
{
"docs": {
"stability": "stable",
"summary": "The number of notifications failed to redrive to the dead-letter queue."
},
"name": "NUMBER_OF_NOTIFICATIONS_FAILED_TO_REDRIVE_TO_DLQ"
}
],
"name": "SnsRecommendedAlarmsMetrics",
"symbolId": "src/sns:SnsRecommendedAlarmsMetrics"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable"
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SnsRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sns.ts",
"line": 702
},
"name": "SnsRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The SNS topic for which to create the alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/sns.ts",
"line": 706
},
"name": "topic",
"type": {
"fqn": "aws-cdk-lib.aws_sns.ITopic"
}
}
],
"symbolId": "src/sns:SnsRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsAlarmBaseConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable"
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsAlarmBaseConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sqs.ts",
"line": 22
},
"name": "SqsAlarmBaseConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "15",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 40
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "15",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 34
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "Duration.minutes(1)",
"stability": "stable",
"summary": "The period over which the specified statistic is applied."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 28
},
"name": "period",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.Duration"
}
}
],
"symbolId": "src/sqs:SqsAlarmBaseConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateAgeOfOldestMessageAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This alarm is used to detect whether the age of the oldest message\nin the QueueName queue is too high. High age can be an indication\nthat messages are not processed quickly enough or that there are\nsome poison-pill messages that are stuck in the queue and can't\nbe processed.\n\nThis alarm is triggered when the age of the oldest message in the\nqueue exceeds or is equal to the specified threshold.",
"stability": "stable",
"summary": "An alarm that watches the age of the oldest message in the queue."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateAgeOfOldestMessageAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/sqs.ts",
"line": 98
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateAgeOfOldestMessageAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/sqs.ts",
"line": 97
},
"name": "SqsApproximateAgeOfOldestMessageAlarm",
"symbolId": "src/sqs:SqsApproximateAgeOfOldestMessageAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateAgeOfOldestMessageAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the ApproximateAgeOfOldestMessage alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateAgeOfOldestMessageAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sqs.ts",
"line": 46
},
"name": "SqsApproximateAgeOfOldestMessageAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "The recommended threshold value for this alarm is highly dependent on the expected message\nprocessing time. You can use historical data to calculate the average message processing time,\nand then set the threshold to 50% higher than the maximum expected SQS message processing\ntime by queue consumers.",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 55
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm watches the age of the oldest message in the queue. You can use this alarm\nto monitor if your consumers are processing SQS messages at the desired speed. Consider increasing\nthe consumer count or consumer throughput to reduce message age. This metric can be used in\ncombination with ApproximateNumberOfMessagesVisible to determine how big the queue backlog is\nand how quickly messages are being processed. To prevent messages from being deleted before processed,\nconsider configuring the dead-letter queue to sideline potential poison pill messages.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 72
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- queue.queueName + ' - ApproximateAgeOfOldestMessage'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 61
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
}
],
"symbolId": "src/sqs:SqsApproximateAgeOfOldestMessageAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateAgeOfOldestMessageAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the SqsApproximateAgeOfOldestMessageAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateAgeOfOldestMessageAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateAgeOfOldestMessageAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sqs.ts",
"line": 78
},
"name": "SqsApproximateAgeOfOldestMessageAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The SQS queue for which to create the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 82
},
"name": "queue",
"type": {
"fqn": "aws-cdk-lib.aws_sqs.IQueue"
}
}
],
"symbolId": "src/sqs:SqsApproximateAgeOfOldestMessageAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesNotVisibleAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This alarm is used to detect a high number of in-flight messages\nin the queue. If consumers do not delete messages within the\nvisibility timeout period, when the queue is polled, messages\nreappear in the queue. For FIFO queues, there can be a maximum\nof 20,000 in-flight messages. If you reach this quota, SQS returns\nno error messages. A FIFO queue looks through the first 20k\nmessages to determine available message groups. This means that\nif you have a backlog of messages in a single message group,\nyou cannot consume messages from other message groups that were\nsent to the queue at a later time until you successfully\nconsume the messages from the backlog.\n\nThis alarm is triggered when the number of messages that are in\nflight exceeds or is equal to the specified threshold.",
"stability": "stable",
"summary": "An alarm that watches the number of messages that are in flight."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesNotVisibleAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/sqs.ts",
"line": 187
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesNotVisibleAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/sqs.ts",
"line": 186
},
"name": "SqsApproximateNumberOfMessagesNotVisibleAlarm",
"symbolId": "src/sqs:SqsApproximateNumberOfMessagesNotVisibleAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesNotVisibleAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the ApproximateNumberOfMessagesNotVisible alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesNotVisibleAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sqs.ts",
"line": 132
},
"name": "SqsApproximateNumberOfMessagesNotVisibleAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "The recommended threshold value for this alarm is highly dependent on the expected number\nof messages in flight. You can use historical data to calculate the maximum expected\nnumber of messages in flight and set the threshold to 50% over this value. If consumers\nof the queue are processing but not deleting messages from the queue, this number will\nsuddenly increase.",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 142
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm helps to detect a high number of in-flight messages with respect to QueueName.\nFor troubleshooting, check message backlog decreasing (https://repost.aws/knowledge-center/sqs-message-backlog).",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 155
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- queue.queueName + ' - ApproximateNumberOfMessagesNotVisible'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 148
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
}
],
"symbolId": "src/sqs:SqsApproximateNumberOfMessagesNotVisibleAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesNotVisibleAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the SqsApproximateNumberOfMessagesNotVisibleAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesNotVisibleAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesNotVisibleAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sqs.ts",
"line": 161
},
"name": "SqsApproximateNumberOfMessagesNotVisibleAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The SQS queue for which to create the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 165
},
"name": "queue",
"type": {
"fqn": "aws-cdk-lib.aws_sqs.IQueue"
}
}
],
"symbolId": "src/sqs:SqsApproximateNumberOfMessagesNotVisibleAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesVisibleAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This alarm is used to detect whether the message\ncount of the active queue is too high and consumers\nare slow to process the messages or there are not\nenough consumers to process them.\n\nThis alarm is triggered when the number of messages\nthat are visible in the queue exceeds or is equal to\nthe specified threshold.",
"stability": "stable",
"summary": "An alarm that watches the number of messages that are visible in the queue."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesVisibleAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/sqs.ts",
"line": 266
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesVisibleAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/sqs.ts",
"line": 265
},
"name": "SqsApproximateNumberOfMessagesVisibleAlarm",
"symbolId": "src/sqs:SqsApproximateNumberOfMessagesVisibleAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesVisibleAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the ApproximateNumberOfMessagesVisible alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesVisibleAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sqs.ts",
"line": 218
},
"name": "SqsApproximateNumberOfMessagesVisibleAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"remarks": "An unexpectedly high number of messages visible indicates that messages are not being\nprocessed by a consumer at the expected rate. You should consider historical data when\nyou set this threshold.",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 226
},
"name": "threshold",
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "- This alarm helps to detect a high number of in-flight messages with respect to QueueName.\nFor troubleshooting, check message backlog decreasing (https://repost.aws/knowledge-center/sqs-message-backlog).",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 239
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- queue.queueName + ' - ApproximateNumberOfMessagesVisible'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 232
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
}
],
"symbolId": "src/sqs:SqsApproximateNumberOfMessagesVisibleAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesVisibleAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the SqsApproximateNumberOfMessagesVisibleAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesVisibleAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesVisibleAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sqs.ts",
"line": 245
},
"name": "SqsApproximateNumberOfMessagesVisibleAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The SQS queue for which to create the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 249
},
"name": "queue",
"type": {
"fqn": "aws-cdk-lib.aws_sqs.IQueue"
}
}
],
"symbolId": "src/sqs:SqsApproximateNumberOfMessagesVisibleAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsNumberOfMessagesSentAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "This alarm is used to detect when a producer stops sending messages.\n\nThis alarm is triggered when the number of messages sent is less than\nor equal to the specified threshold. By default, 0.",
"stability": "stable",
"summary": "An alarm that watches the number of messages that are sent."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsNumberOfMessagesSentAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/sqs.ts",
"line": 340
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsNumberOfMessagesSentAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/sqs.ts",
"line": 339
},
"name": "SqsNumberOfMessagesSentAlarm",
"symbolId": "src/sqs:SqsNumberOfMessagesSentAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsNumberOfMessagesSentAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the NumberOfMessagesSent alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsNumberOfMessagesSentAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sqs.ts",
"line": 296
},
"name": "SqsNumberOfMessagesSentAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm helps to detect a high number of in-flight messages with respect\nto QueueName. For troubleshooting, check message backlog decreasing (https://repost.aws/knowledge-center/sqs-message-backlog).",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 318
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- queue.queueName + ' - NumberOfMessagesSent'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 311
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "0",
"remarks": "If the number of messages sent is 0, the producer is not sending any messages.\nIf this queue has a low TPS, increase the number of EvaluationPeriods accordingly.",
"stability": "stable",
"summary": "The value against which the specified statistic is compared."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 305
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/sqs:SqsNumberOfMessagesSentAlarmConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsNumberOfMessagesSentAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the SqsNumberOfMessagesSentAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsNumberOfMessagesSentAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsNumberOfMessagesSentAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sqs.ts",
"line": 324
},
"name": "SqsNumberOfMessagesSentAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The SQS queue for which to create the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 328
},
"name": "queue",
"type": {
"fqn": "aws-cdk-lib.aws_sqs.IQueue"
}
}
],
"symbolId": "src/sqs:SqsNumberOfMessagesSentAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"stability": "stable"
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/sqs.ts",
"line": 468
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/sqs.ts",
"line": 450
},
"name": "SqsRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The approximate age of oldest message alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 454
},
"name": "alarmApproximateAgeOfOldestMessage",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateAgeOfOldestMessageAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The approximate number of messages not visible alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 458
},
"name": "alarmApproximateNumberOfMessagesNotVisible",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesNotVisibleAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The approximate number of messages visible alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 462
},
"name": "alarmApproximateNumberOfMessagesVisible",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesVisibleAlarm"
}
},
{
"docs": {
"stability": "stable",
"summary": "The number of messages sent alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 466
},
"name": "alarmNumberOfMessagesSent",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsNumberOfMessagesSentAlarm"
}
}
],
"symbolId": "src/sqs:SqsRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsRecommendedAlarmsAspect": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"remarks": "Requires defining thresholds for some alarms.",
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#SQS",
"stability": "stable",
"summary": "Configured the recommended alarms for an SQS queue."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsRecommendedAlarmsAspect",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/sqs.ts",
"line": 634
},
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsRecommendedAlarmsConfig"
}
}
]
},
"interfaces": [
"aws-cdk-lib.IAspect"
],
"kind": "class",
"locationInModule": {
"filename": "src/sqs.ts",
"line": 621
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "All aspects can visit an IConstruct."
},
"locationInModule": {
"filename": "src/sqs.ts",
"line": 636
},
"name": "visit",
"overrides": "aws-cdk-lib.IAspect",
"parameters": [
{
"name": "node",
"type": {
"fqn": "constructs.IConstruct"
}
}
]
}
],
"name": "SqsRecommendedAlarmsAspect",
"properties": [
{
"docs": {
"remarks": "We exclude these from the recommended alarms\nbecause they don't make sense.",
"stability": "stable",
"summary": "A list of dead letter queues discovered in the scope."
},
"locationInModule": {
"filename": "src/sqs.ts",
"line": 627
},
"name": "deadLetterQueues",
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"docs": {
"remarks": "This is used to prevent running the discovery logic on every call to `visit`.",
"stability": "stable",
"summary": "A flag to indicate whether dead letter queues have been discovered."
},
"locationInModule": {
"filename": "src/sqs.ts",
"line": 632
},
"name": "deadLetterQueuesDiscovered",
"type": {
"primitive": "boolean"
}
}
],
"symbolId": "src/sqs:SqsRecommendedAlarmsAspect"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the recommended alarms for an SQS queue."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsRecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/sqs.ts",
"line": 369
},
"name": "SqsRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the approximate age of oldest message alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 409
},
"name": "configApproximateAgeOfOldestMessageAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateAgeOfOldestMessageAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the approximate number of messages not visible alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 413
},
"name": "configApproximateNumberOfMessagesNotVisibleAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesNotVisibleAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the approximate number of messages visible alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 417
},
"name": "configApproximateNumberOfMessagesVisibleAlarm",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesVisibleAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"remarks": "This is used for dead letter queues only. The threshold is set to 0 by default.",
"stability": "stable",
"summary": "The configuration for the approximate number of messages visible alarm for DLQs."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 437
},
"name": "configDlqApproximateNumberOfMessagesVisibleAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsApproximateNumberOfMessagesVisibleAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the number of messages sent alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 421
},
"name": "configNumberOfMessagesSentAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsNumberOfMessagesSentAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 375
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 387
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 381
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "false",
"remarks": "If true, the dead letter queues will have the same alarms as normal queues.\nIf false, the dead letter queues will only have the ApproximateNumberOfMessagesVisible\nalarm with a default threshold of 0.",
"stability": "stable",
"summary": "Whether to apply the usual recommended alarms to dead letter queues."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 431
},
"name": "dlqsGetFullRecommendedAlarms",
"optional": true,
"type": {
"primitive": "boolean"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 399
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsRecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 405
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 393
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/sqs:SqsRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsRecommendedAlarmsMetrics": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "The recommended metrics for SQS queue alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsRecommendedAlarmsMetrics",
"kind": "enum",
"locationInModule": {
"filename": "src/sqs.ts",
"line": 15
},
"members": [
{
"docs": {
"stability": "stable"
},
"name": "APPROXIMATE_AGE_OF_OLDEST_MESSAGE"
},
{
"docs": {
"stability": "stable"
},
"name": "APPROXIMATE_NUMBER_OF_MESSAGES_NOT_VISIBLE"
},
{
"docs": {
"stability": "stable"
},
"name": "APPROXIMATE_NUMBER_OF_MESSAGES_VISIBLE"
},
{
"docs": {
"stability": "stable"
},
"name": "NUMBER_OF_MESSAGES_SENT"
}
],
"name": "SqsRecommendedAlarmsMetrics",
"symbolId": "src/sqs:SqsRecommendedAlarmsMetrics"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the SqsRecommendedAlarms construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SqsRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.SqsRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/sqs.ts",
"line": 443
},
"name": "SqsRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The SQS queue for which to create the alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/sqs.ts",
"line": 447
},
"name": "queue",
"type": {
"fqn": "aws-cdk-lib.aws_sqs.IQueue"
}
}
],
"symbolId": "src/sqs:SqsRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.StateMachine": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_stepfunctions.StateMachine",
"docs": {
"stability": "stable",
"summary": "An extension for the StateMachine construct that provides methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.StateMachine",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/states.ts",
"line": 626
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "aws-cdk-lib.aws_stepfunctions.StateMachineProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/states.ts",
"line": 625
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the ExecutionsFailed for the StepFunctions stateMachine."
},
"locationInModule": {
"filename": "src/states.ts",
"line": 653
},
"name": "alarmExecutionsFailed",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsFailedAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsFailedAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the ExecutionsTimedOut for the StepFunctions stateMachine."
},
"locationInModule": {
"filename": "src/states.ts",
"line": 663
},
"name": "alarmExecutionsTimedOut",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsTimedOutAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionsTimedOutAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the ExecutionThrottled for the StepFunctions stateMachine."
},
"locationInModule": {
"filename": "src/states.ts",
"line": 643
},
"name": "alarmExecutionThrottled",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionThrottledAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionThrottledAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the ExecutionTime for the StepFunctions stateMachine."
},
"locationInModule": {
"filename": "src/states.ts",
"line": 633
},
"name": "alarmExecutionTime",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionTimeAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineExecutionTimeAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates the recommended alarms for the StepFunctions StateMachine."
},
"locationInModule": {
"filename": "src/states.ts",
"line": 673
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineRecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SfStateMachineRecommendedAlarms"
}
}
}
],
"name": "StateMachine",
"symbolId": "src/states:StateMachine"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.Table": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_dynamodb.Table",
"docs": {
"stability": "stable",
"summary": "An extension for the Table construct that provides methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Table",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 885
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "aws-cdk-lib.aws_dynamodb.TableProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 884
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the AgeOfOldestUnreplicatedRecord for the DynamoDb table."
},
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 922
},
"name": "alarmAgeOfOldestUnreplicatedRecord",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbAgeOfOldestUnreplicatedRecordAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the FailedToReplicateRecordCount for the DynamoDb table."
},
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 934
},
"name": "alarmFailedToReplicateRecordCount",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbFailedToReplicateRecordCountAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableFailedToReplicateRecordCountAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the ReadThrottleEvents for the DynamoDb table."
},
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 892
},
"name": "alarmReadThrottleEvents",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbReadThrottleEventsAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableReadThrottleEventsAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the SystemErrors for the DynamoDb table."
},
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 902
},
"name": "alarmSystemErrors",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbSystemErrorsAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableSystemErrorsAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the ThrottledPutRecordCount for the DynamoDb table."
},
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 946
},
"name": "alarmThrottledPutRecordCount",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbThrottledPutRecordCountAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableThrottledPutRecordCountAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the WriteThrottleEvents for the DynamoDb table."
},
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 912
},
"name": "alarmWriteThrottleEvents",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbWriteThrottleEventsAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableWriteThrottleEventsAlarm"
}
}
},
{
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#DynamoDB",
"stability": "stable",
"summary": "Creates the recommended alarms for the DynamoDb Table."
},
"locationInModule": {
"filename": "src/dynamodb.ts",
"line": 960
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableRecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.DynamoDbTableRecommendedAlarms"
}
}
}
],
"name": "Table",
"symbolId": "src/dynamodb:Table"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.Topic": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_sns.Topic",
"docs": {
"stability": "stable",
"summary": "An extension of the SNS topic construct that provides helper methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.Topic",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/sns.ts",
"line": 894
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_sns.TopicProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/sns.ts",
"line": 893
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm for the NumberOfMessagesPublished metric."
},
"locationInModule": {
"filename": "src/sns.ts",
"line": 901
},
"name": "alarmNumberOfMessagesPublished",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfMessagesPublishedAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfMessagesPublishedAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm for the NumberOfNotificationsDelivered metric."
},
"locationInModule": {
"filename": "src/sns.ts",
"line": 913
},
"name": "alarmNumberOfNotificationsDelivered",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsDeliveredAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsDeliveredAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm for the NumberOfNotificationsFailed metric."
},
"locationInModule": {
"filename": "src/sns.ts",
"line": 925
},
"name": "alarmNumberOfNotificationsFailed",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm for the NumberOfNotificationsFailedToRedriveToDlq metric."
},
"locationInModule": {
"filename": "src/sns.ts",
"line": 973
},
"name": "alarmNumberOfNotificationsFailedToRedriveToDlq",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedToRedriveToDlqAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFailedToRedriveToDlqAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm for the NumberOfNotificationsFilteredOutInvalidAttributes metric."
},
"locationInModule": {
"filename": "src/sns.ts",
"line": 937
},
"name": "alarmNumberOfNotificationsFilteredOutInvalidAttributes",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm for the NumberOfNotificationsFilteredOutInvalidMessageBody metric."
},
"locationInModule": {
"filename": "src/sns.ts",
"line": 949
},
"name": "alarmNumberOfNotificationsFilteredOutInvalidMessageBody",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm"
}
}
},
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm for the NumberOfNotificationsRedrivenToDlq metric."
},
"locationInModule": {
"filename": "src/sns.ts",
"line": 961
},
"name": "alarmNumberOfNotificationsRedrivenToDlq",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsRedrivenToDlqAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsNumberOfNotificationsRedrivenToDlqAlarm"
}
}
},
{
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#SNS",
"stability": "stable",
"summary": "Creates recommended alarms for the SNS topic."
},
"locationInModule": {
"filename": "src/sns.ts",
"line": 987
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsRecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.SnsRecommendedAlarms"
}
}
}
],
"name": "Topic",
"symbolId": "src/sns:Topic"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.VpcEndpointService": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_ec2.VpcEndpointService",
"docs": {
"stability": "stable",
"summary": "An extension for the VpcEndpointService construct that provides methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.VpcEndpointService",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 620
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "aws-cdk-lib.aws_ec2.VpcEndpointServiceProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 619
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the RstPacketsSent for the PrivateLink endpoint."
},
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 627
},
"name": "alarmRstPacketsSent",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesRstPacketsSentAlarmConfig"
}
}
],
"returns": {
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm"
},
"kind": "array"
}
}
}
},
{
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#PrivateLinkServices",
"stability": "stable",
"summary": "Creates the recommended alarms for the PrivateLink VpcEndpointService."
},
"locationInModule": {
"filename": "src/privatelink.ts",
"line": 660
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesVpcEndpointServiceRecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.PrivateLinkServicesVpcEndpointServiceRecommendedAlarms"
}
}
}
],
"name": "VpcEndpointService",
"symbolId": "src/privatelink:VpcEndpointService"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.VpnAlarmBaseConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common optional configuration for the alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.VpnAlarmBaseConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.AlarmBaseProps"
],
"kind": "interface",
"locationInModule": {
"filename": "src/vpn.ts",
"line": 24
},
"name": "VpnAlarmBaseConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "Duration.minutes(5)",
"stability": "stable",
"summary": "The period over which the specified statistic is applied."
},
"immutable": true,
"locationInModule": {
"filename": "src/vpn.ts",
"line": 30
},
"name": "period",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.Duration"
}
}
],
"symbolId": "src/vpn:VpnAlarmBaseConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.VpnConnection": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_ec2.CfnVPNConnection",
"docs": {
"stability": "stable",
"summary": "An extension for the CfnVPNConnection construct that provides methods to create recommended alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.VpnConnection",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/vpn.ts",
"line": 239
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "aws-cdk-lib.aws_ec2.CfnVPNConnectionProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/vpn.ts",
"line": 238
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "Creates an alarm that monitors the TunnelState for the VPN vpnConnection."
},
"locationInModule": {
"filename": "src/vpn.ts",
"line": 246
},
"name": "alarmTunnelState",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.VpnTunnelStateAlarmConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.VpnConnectionTunnelStateAlarm"
}
}
},
{
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#VPN",
"stability": "stable",
"summary": "Creates the recommended alarms for the VpnConnection."
},
"locationInModule": {
"filename": "src/vpn.ts",
"line": 258
},
"name": "applyRecommendedAlarms",
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.VpnConnectionRecommendedAlarmsConfig"
}
}
],
"returns": {
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.VpnConnectionRecommendedAlarms"
}
}
}
],
"name": "VpnConnection",
"symbolId": "src/vpn:VpnConnection"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.VpnConnectionAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The common properties for the VpnConnection alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.VpnConnectionAlarmProps",
"kind": "interface",
"locationInModule": {
"filename": "src/vpn.ts",
"line": 36
},
"name": "VpnConnectionAlarmProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The VpnConnection to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/vpn.ts",
"line": 40
},
"name": "vpnConnection",
"type": {
"fqn": "aws-cdk-lib.aws_ec2.CfnVPNConnection"
}
}
],
"symbolId": "src/vpn:VpnConnectionAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.VpnConnectionRecommendedAlarms": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "constructs.Construct",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#VPN",
"stability": "stable",
"summary": "A construct that creates the recommended alarms for an VpnConnection."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.VpnConnectionRecommendedAlarms",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/vpn.ts",
"line": 200
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.Construct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.VpnConnectionRecommendedAlarmsProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/vpn.ts",
"line": 194
},
"name": "VpnConnectionRecommendedAlarms",
"properties": [
{
"docs": {
"stability": "stable",
"summary": "The TunnelState alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/vpn.ts",
"line": 198
},
"name": "alarmTunnelState",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.VpnConnectionTunnelStateAlarm"
}
}
],
"symbolId": "src/vpn:VpnConnectionRecommendedAlarms"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.VpnConnectionRecommendedAlarmsConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"remarks": "Default actions are overridden by the actions specified in the\nindividual alarm configurations.",
"stability": "stable",
"summary": "Configurations for the recommended alarms for an VPN Service."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.VpnConnectionRecommendedAlarmsConfig",
"kind": "interface",
"locationInModule": {
"filename": "src/vpn.ts",
"line": 136
},
"name": "VpnConnectionRecommendedAlarmsConfig",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The configuration for the TunnelState alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/vpn.ts",
"line": 176
},
"name": "configTunnelStateAlarm",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.VpnTunnelStateAlarmConfig"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm is triggered."
},
"immutable": true,
"locationInModule": {
"filename": "src/vpn.ts",
"line": 142
},
"name": "defaultAlarmAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm has insufficient data."
},
"immutable": true,
"locationInModule": {
"filename": "src/vpn.ts",
"line": 154
},
"name": "defaultInsufficientDataAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "The default action to take when an alarm enters the ok state."
},
"immutable": true,
"locationInModule": {
"filename": "src/vpn.ts",
"line": 148
},
"name": "defaultOkAction",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarmAction"
}
},
{
"abstract": true,
"docs": {
"default": "- None",
"stability": "stable",
"summary": "Alarm metrics to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/vpn.ts",
"line": 166
},
"name": "excludeAlarms",
"optional": true,
"type": {
"collection": {
"elementtype": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.VpnRecommendedAlarmsMetrics"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"remarks": "Use a resources id to exclude a specific resource.",
"stability": "stable",
"summary": "The resources to exclude from the recommended alarms."
},
"immutable": true,
"locationInModule": {
"filename": "src/vpn.ts",
"line": 172
},
"name": "excludeResources",
"optional": true,
"type": {
"collection": {
"elementtype": {
"primitive": "string"
},
"kind": "array"
}
}
},
{
"abstract": true,
"docs": {
"default": "TreatMissingData.MISSING",
"stability": "stable",
"summary": "How to handle missing data for this alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/vpn.ts",
"line": 160
},
"name": "treatMissingData",
"optional": true,
"type": {
"fqn": "aws-cdk-lib.aws_cloudwatch.TreatMissingData"
}
}
],
"symbolId": "src/vpn:VpnConnectionRecommendedAlarmsConfig"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.VpnConnectionRecommendedAlarmsProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Properties for the VpnConnectionRecommendedAlarms construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.VpnConnectionRecommendedAlarmsProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.VpnConnectionRecommendedAlarmsConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/vpn.ts",
"line": 182
},
"name": "VpnConnectionRecommendedAlarmsProps",
"properties": [
{
"abstract": true,
"docs": {
"stability": "stable",
"summary": "The VpnConnection to monitor."
},
"immutable": true,
"locationInModule": {
"filename": "src/vpn.ts",
"line": 186
},
"name": "vpnConnection",
"type": {
"fqn": "aws-cdk-lib.aws_ec2.CfnVPNConnection"
}
}
],
"symbolId": "src/vpn:VpnConnectionRecommendedAlarmsProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.VpnConnectionTunnelStateAlarm": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"base": "aws-cdk-lib.aws_cloudwatch.Alarm",
"docs": {
"remarks": "For troubleshooting, see VPN tunnel troubleshooting.\n\nThe alarm is triggered when the monitored value is less than 1.",
"stability": "stable",
"summary": "This alarm helps you understand if the state of one or more tunnels is DOWN."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.VpnConnectionTunnelStateAlarm",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/vpn.ts",
"line": 93
},
"parameters": [
{
"name": "scope",
"type": {
"fqn": "constructs.IConstruct"
}
},
{
"name": "id",
"type": {
"primitive": "string"
}
},
{
"name": "props",
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.VpnConnectionTunnelStateAlarmProps"
}
}
]
},
"kind": "class",
"locationInModule": {
"filename": "src/vpn.ts",
"line": 92
},
"name": "VpnConnectionTunnelStateAlarm",
"symbolId": "src/vpn:VpnConnectionTunnelStateAlarm"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.VpnConnectionTunnelStateAlarmProps": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "The properties for the VpnConnectionTunnelStateAlarm construct."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.VpnConnectionTunnelStateAlarmProps",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.VpnConnectionAlarmProps",
"@renovosolutions/cdk-library-cloudwatch-alarms.VpnTunnelStateAlarmConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/vpn.ts",
"line": 83
},
"name": "VpnConnectionTunnelStateAlarmProps",
"symbolId": "src/vpn:VpnConnectionTunnelStateAlarmProps"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.VpnRecommendedAlarmsAspect": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#VPN",
"stability": "stable",
"summary": "Configures the recommended alarms for an VpnConnection."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.VpnRecommendedAlarmsAspect",
"initializer": {
"docs": {
"stability": "stable"
},
"locationInModule": {
"filename": "src/vpn.ts",
"line": 272
},
"parameters": [
{
"name": "props",
"optional": true,
"type": {
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.VpnConnectionRecommendedAlarmsConfig"
}
}
]
},
"interfaces": [
"aws-cdk-lib.IAspect"
],
"kind": "class",
"locationInModule": {
"filename": "src/vpn.ts",
"line": 271
},
"methods": [
{
"docs": {
"stability": "stable",
"summary": "All aspects can visit an IConstruct."
},
"locationInModule": {
"filename": "src/vpn.ts",
"line": 274
},
"name": "visit",
"overrides": "aws-cdk-lib.IAspect",
"parameters": [
{
"name": "node",
"type": {
"fqn": "constructs.IConstruct"
}
}
]
}
],
"name": "VpnRecommendedAlarmsAspect",
"symbolId": "src/vpn:VpnRecommendedAlarmsAspect"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.VpnRecommendedAlarmsMetrics": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"docs": {
"stability": "stable",
"summary": "The recommended metrics for VPN alarms."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.VpnRecommendedAlarmsMetrics",
"kind": "enum",
"locationInModule": {
"filename": "src/vpn.ts",
"line": 13
},
"members": [
{
"docs": {
"stability": "stable",
"summary": "Percentage of how close a file system is to reaching the I/O limit of the General Purpose performance mode."
},
"name": "TUNNEL_STATE"
}
],
"name": "VpnRecommendedAlarmsMetrics",
"symbolId": "src/vpn:VpnRecommendedAlarmsMetrics"
},
"@renovosolutions/cdk-library-cloudwatch-alarms.VpnTunnelStateAlarmConfig": {
"assembly": "@renovosolutions/cdk-library-cloudwatch-alarms",
"datatype": true,
"docs": {
"stability": "stable",
"summary": "Configuration for the TunnelState alarm."
},
"fqn": "@renovosolutions/cdk-library-cloudwatch-alarms.VpnTunnelStateAlarmConfig",
"interfaces": [
"@renovosolutions/cdk-library-cloudwatch-alarms.VpnAlarmBaseConfig"
],
"kind": "interface",
"locationInModule": {
"filename": "src/vpn.ts",
"line": 46
},
"name": "VpnTunnelStateAlarmConfig",
"properties": [
{
"abstract": true,
"docs": {
"default": "- This alarm is used to detect if at least one tunnel is in the DOWN state for this VPN, so that you can troubleshoot\nthe impacted VPN. This alarm will always be in the ALARM state for networks that only have a single tunnel configured.",
"stability": "stable",
"summary": "The description of the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/vpn.ts",
"line": 77
},
"name": "alarmDescription",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "- vpnConnectionId + ' - TunnelState'",
"stability": "stable",
"summary": "The alarm name."
},
"immutable": true,
"locationInModule": {
"filename": "src/vpn.ts",
"line": 70
},
"name": "alarmName",
"optional": true,
"type": {
"primitive": "string"
}
},
{
"abstract": true,
"docs": {
"default": "3",
"stability": "stable",
"summary": "The number of data points that must be breaching to trigger the alarm."
},
"immutable": true,
"locationInModule": {
"filename": "src/vpn.ts",
"line": 64
},
"name": "datapointsToAlarm",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "3",
"stability": "stable",
"summary": "The number of periods over which data is compared to the specified threshold."
},
"immutable": true,
"locationInModule": {
"filename": "src/vpn.ts",
"line": 58
},
"name": "evaluationPeriods",
"optional": true,
"type": {
"primitive": "number"
}
},
{
"abstract": true,
"docs": {
"default": "1",
"stability": "stable",
"summary": "A value less than 1 indicates that at least one tunnel is in DOWN state."
},
"immutable": true,
"locationInModule": {
"filename": "src/vpn.ts",
"line": 52
},
"name": "threshold",
"optional": true,
"type": {
"primitive": "number"
}
}
],
"symbolId": "src/vpn:VpnTunnelStateAlarmConfig"
}
},
"version": "0.0.13",
"fingerprint": "1rVySxvc28IJXFYbTG2S5DtlEb8NU4MGaFb6uQk972s="
}